airier 0.0.1 → 0.0.3

package/.eslintrc.js

@@ -1,6 +1,6 @@
-const { eslint_config } = require('actuallymentor/airier')
+import { eslint_config } from 'airier'
 
 // Export the default eslint config
-module.exports = {
+export default {
     ...eslint_config
 }

package/.eslintrc.onlystyles.example.js

@@ -1,6 +1,6 @@
-const { eslint_config } = require('actuallymentor/airier')
+import { eslint_config } from 'airier'
 
 // Export the default eslint config
-module.exports = {
+export default {
     ...eslint_config
 }

package/README.md

@@ -4,32 +4,28 @@ A shared set of standards and preferences, enforced through eslint and vscode. P
 
 ## Quickstart
 
-To use:
-
-1. `npm install -D airier @babel/eslint-parser @babel/preset-react eslint eslint-plugin-react husky`
-1. Copy `.eslintrc.js` to your project's `.eslintrc.js`
-1. Copy `.babelrc` to your project's `.babelrc`
-1. Copy `.vscode/settings.json` to your project's `.vscode/settings.json`
-1. Copy `.husky/pre-commit` to your project's `.husky/pre-commit`
-1. Run husky initial setup
+```shell
+# Install dependencies
+npm install -D airier @babel/eslint-parser @babel/preset-react eslint eslint-plugin-react eslint-plugin-unused-imports husky
+mkdir .vscode .husky || echo "Directories already exist"
 
-Lazy shell
+# Create scripts
+npm pkg set scripts.lint="eslint --fix src"
 
-```shell
-npm install -D airier @babel/eslint-parser @babel/preset-react eslint eslint-plugin-react husky
-mkdir .vscode .husky
+# Init husky
+npx husky init
 
 # Download files
 curl https://raw.githubusercontent.com/actuallymentor/airier/main/.eslintrc.js --output .eslintrc.js
 curl https://raw.githubusercontent.com/actuallymentor/airier/main/.vscode/settings.json --output .vscode/settings.json
 curl https://raw.githubusercontent.com/actuallymentor/airier/main/.husky/pre-commit --output .husky/pre-commit
 curl https://raw.githubusercontent.com/actuallymentor/airier/main/.babelrc --output .babelrc
+
+# Add files to git
 git add -f .eslintrc.js .babelrc .vscode/* .husky/*
+
+# Make husky executable
 chmod ug+x .husky/*
-npm pkg set scripts.prepare="husky install"
-npm pkg set scripts.lint="eslint --fix src"
-npm run prepare
-npx husky add .husky/pre-commit
 git add .husky/pre-commit
 ```
 
@@ -45,6 +41,6 @@ The relevant source files are in `modules/`. If you make a change, you can updat
 
 If you are cloning this repo and want to reuse it to create an npm package. These are the one-time setup instructions:
 
-1. You need to do the one-time first publishing manually by running `npm publish --access public` in the root of the project. This will create the package on npmjs and allow you to create a granular token.
+1. You need to do the one-time first publishing manually by running `npm publish --access public` in the root of the project. This will create the package on npmjs and allow you to create a granular token. This requires you to rename `.npmrc` to `.npmrc.bak` temporatily.
 1. You need to obtain a NPM_ACCESS_TOKEN on npmjs (https://www.npmjs.com/settings/YOURUSERNAME/tokens/granular-access-tokens/new). Note that granular tokens expire!
 # airier

package/index.js

@@ -1,7 +1,6 @@
-const eslint_config = require( './modules/eslint_config.js' )
-const styleguide = require( './modules/styleguide.js' )
+// Import the modules using ES Module syntax
+import eslint_config from './modules/eslint_config.js'
+import styleguide from './modules/styleguide.js'
 
-module.exports = {
-    eslint_config,
-    styleguide
-}
+// Export the objects in an object literal
+export { eslint_config, styleguide }

package/modules/eslint_config.js

@@ -1,6 +1,8 @@
-const styleguide = require('./styleguide.js')
+// Import the styleguide module using ES Module syntax
+import styleguide from './styleguide.js'
 
-module.exports = {
+// Export the configuration object using `export default`
+export default {
 
     // Recommended features
     "extends": [ "eslint:recommended", "plugin:react/recommended" ],
@@ -24,15 +26,8 @@ module.exports = {
 
     // Rules
     rules: {
-
         // Import styleguide
-        ...styleguide,
-
-        // React config
-        "react/no-unescaped-entities": 0,
-        "react/react-in-jsx-scope": 0, // CRA globally imports "react" so we don't need to do it
-        "react/prop-types": 0,
-        "react/display-name": 0
+        ...styleguide
     },
 
     // What environment to run in
@@ -52,5 +47,4 @@ module.exports = {
         Cypress: true,
         expect: true
     }
-
-}
+}

package/modules/styleguide.js

@@ -3,7 +3,7 @@
 // warn: we recomment this to change, but there are instances where you can choose to ignore it
 // error: there is no reason for you to do this
 
-module.exports = {
+export default {
 
     /* ///////////////////////////////
     // Built-in rules
@@ -83,6 +83,10 @@ module.exports = {
     "react/jsx-indent": "warn",
     "react/jsx-indent-props": "warn",
     "react/jsx-no-useless-fragment": "error",
+    "react/no-unescaped-entities": 0,
+    "react/react-in-jsx-scope": 0, // CRA globally imports "react" so we don't need to do it
+    "react/prop-types": 0,
+    "react/display-name": 0,
 
     /* ///////////////////////////////
     // Plugins

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "airier",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Opinionated Eslint and VSCode style guide",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -16,7 +17,7 @@
     "url": "https://github.com/actuallymentor/airier/issues"
   },
   "homepage": "https://github.com/actuallymentor/airier#readme",
-  "devDependencies": {
+  "peerDependencies": {
     "eslint-plugin-unused-imports": "^3.1.0"
   }
-}
+}

package/.npmrc.bak

@@ -1 +0,0 @@
-//registry.npmjs.org/:_authToken=${NPM_ACCESS_TOKEN}