Merge pull request #37 from simonhamp/feature/nova-4

Nova 4

Author: simonhamp

README.md

@@ -1,22 +1,35 @@
 # Laravel Nova CSV Import
 
-[![Latest Stable Version](https://poser.pugx.org/simonhamp/laravel-nova-csv-import/v/stable)](https://packagist.org/packages/simonhamp/laravel-nova-csv-import)
-[![Total Downloads](https://poser.pugx.org/simonhamp/laravel-nova-csv-import/downloads)](https://packagist.org/packages/simonhamp/laravel-nova-csv-import)
-[![License](https://poser.pugx.org/simonhamp/laravel-nova-csv-import/license)](https://packagist.org/packages/simonhamp/laravel-nova-csv-import)
+[![Latest Stable Version](https://poser.pugx.org/simonhamp/laravel-nova-csv-import/v/stable?style=for-the-badge)](https://packagist.org/packages/simonhamp/laravel-nova-csv-import)
+[![Total Downloads](https://poser.pugx.org/simonhamp/laravel-nova-csv-import/downloads?style=for-the-badge)](https://packagist.org/packages/simonhamp/laravel-nova-csv-import)
+[![License](https://poser.pugx.org/simonhamp/laravel-nova-csv-import/license?style=for-the-badge)](https://packagist.org/packages/simonhamp/laravel-nova-csv-import)
 
-A simple CSV import tool for Laravel Nova. This package builds on top of the great work done by Sparclex with the [nova-import-card](https://github.com/Sparclex/nova-import-card) package.
+A simple CSV import tool for Laravel Nova that allows you to upload a CSV file via Nova and choose which Nova resource
+to import it to.
+
+The import process lets you choose how to map the relevant columns from your uploaded file to the attributes on your
+models, with a nice summary at the end of what worked and what didn't
+
+> This package builds on top of the great work done by Sparclex with the [nova-import-card](https://github.com/Sparclex/nova-import-card) package.
 
 ![Laravel Nova CSV Import Screenshot](https://raw.githubusercontent.com/simonhamp/laravel-nova-csv-import/master/screenshots/readme.png)
 
+## Sponsorship
+CSV Import is completely free to use. I've built it in my own time to fill my own needs and I also support it in my own
+time. If you'd like to show your appreciation for that, I do accept [donations via GitHub](https://github.com/sponsors/simonhamp).
+
+Thank you 🙏
+
 ## Installation
 
 Install via Composer:
 
 ```bash
-composer require simonhamp/laravel-nova-csv-import
+composer require simonhamp/laravel-nova-csv-import --with-all-dependencies
 ```
 
-Once installed, you must register the component in your app's `NovaServiceProvider` (`app/Providers/NovaServiceProvider.php`):
+Once installed, you must register the component in your app's `NovaServiceProvider`
+(usually in `app/Providers/NovaServiceProvider.php`):
 
 ```php
 namespace App\Providers;
@@ -35,18 +48,21 @@ class NovaServiceProvider extends NovaApplicationServiceProvider
 ```
 
 ## Options
-By default, all of your Nova Resources will be available for import. However, there are a number of ways that you can explicitly limit what's available for importing.
+By default, _all_ of your Nova Resources will be available for import. However, there are a number of ways that you can
+explicitly limit what's available for importing.
 
 `public static $canImportResource = false;`  
 *Default:* `true`  
 Add this static property to your Resource to prevent it from showing up in the Nova CSV Import tool interface.
 
 `public static function canImportResource($request): bool`  
-Define a `canImportResource` method to use more complex logic to decide if this Resource can be shown during import. If defined, this takes precedence over the `$canImportResource` property.
+Define a `canImportResource` method to use more complex logic to decide if this Resource can be shown during import.
+If defined, this takes precedence over the `$canImportResource` property.
 
 `public static function excludeAttributesFromImport(): array`  
 *Default:* `[]`  
-Define a `excludeAttributesFromImport` method that returns an array of attribute names that you want to _exclude_ from being visible in the import tool for this Resource.
+Define a `excludeAttributesFromImport` method that returns an array of attribute names that you want to _exclude_ from
+being visible in the import tool for this Resource.
 
 
 ### Example 
@@ -65,9 +81,12 @@ public static function excludeAttributesFromImport()
 ```
 
 ## Importer Class 
-This package uses [maatwebsite/excel](https://github.com/Maatwebsite/Laravel-Excel) behind the scenes to handle the actual import. You can find more information about how importing [works here](https://docs.laravel-excel.com/3.1/imports/basics.html#importing-basics).
+This package uses [maatwebsite/excel](https://github.com/Maatwebsite/Laravel-Excel) behind the scenes to handle the
+actual import. You can find more information about how importing
+[works here](https://docs.laravel-excel.com/3.1/imports/basics.html#importing-basics).
 
-You can define your own importer class by providing the relevant class name in your published copy of this package's config file.
+You can define your own importer class by providing the relevant class name in your published copy of this package's
+config file.
 
 First, publish the config file:
 ```

composer.json

@@ -8,6 +8,7 @@
     "license": "MIT",
     "require": {
         "php": ">=7.1.0",
+        "laravel/nova": "^4.0",
         "maatwebsite/excel": "^3.1"
     },
     "autoload": {

dist/css/tool.css

@@ -0,0 +1 @@
+

dist/js/tool.js

@@ -1,3 +1,4 @@
 {
-    "/js/tool.js": "/js/tool.js"
-}
+    "/js/tool.js": "/js/tool.js",
+    "/css/tool.css": "/css/tool.css"
+}

dist/mix-manifest.json

@@ -0,0 +1,33 @@
+const mix = require('laravel-mix')
+const webpack = require('webpack')
+const path = require('path')
+
+class NovaExtension {
+  name() {
+    return 'nova-extension'
+  }
+
+  register(name) {
+    this.name = name
+  }
+
+  webpackConfig(webpackConfig) {
+    webpackConfig.externals = {
+      vue: 'Vue',
+    }
+
+    webpackConfig.resolve.alias = {
+      ...(webpackConfig.resolve.alias || {}),
+      'laravel-nova': path.join(
+        __dirname,
+        '../../vendor/laravel/nova/resources/js/mixins/packages.js'
+      ),
+    }
+
+    webpackConfig.output = {
+      uniqueName: this.name,
+    }
+  }
+}
+
+mix.extend('nova', new NovaExtension())

mix.js

@@ -1,19 +1,19 @@
 {
-    "private": true,
-    "scripts": {
-        "dev": "npm run development",
-        "development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
-        "watch": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --watch --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
-        "watch-poll": "npm run watch -- --watch-poll",
-        "hot": "cross-env NODE_ENV=development node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --hot --config=node_modules/laravel-mix/setup/webpack.config.js",
-        "prod": "npm run production",
-        "production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
-    },
-    "devDependencies": {
-        "cross-env": "^5.0.0",
-        "laravel-mix": "^1.0"
-    },
-    "dependencies": {
-        "vue": "^2.5.0"
-    }
+  "private": true,
+  "scripts": {
+    "dev": "npm run development",
+    "development": "mix",
+    "watch": "mix watch",
+    "watch-poll": "mix watch -- --watch-options-poll=1000",
+    "hot": "mix watch --hot",
+    "prod": "npm run production",
+    "production": "mix --production"
+  },
+  "devDependencies": {
+    "@vue/compiler-sfc": "^3.2.22",
+    "laravel-mix": "^6.0.41",
+    "postcss": "^8.3.11",
+    "vue-loader": "^16.8.3"
+  },
+  "dependencies": {}
 }

package.json

@@ -0,0 +1 @@
+/* Nova Tool CSS */