airier 0.0.1

package/.babelrc

@@ -0,0 +1,5 @@
+{
+    "presets": [
+        "@babel/preset-react"
+    ]
+}

package/.eslintrc.js

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

package/.eslintrc.onlystyles.example.js

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

package/.husky/pre-commit

@@ -0,0 +1,21 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+echo "\n🤖 [ precommit hook ] linting before committing..."
+
+
+# If errors, make it clear they cannot commit
+if ! lint_outcome=$( npm run lint ); then
+    echo "🚨 [ precommit hook ] lint encountered blocking issues, fix them before committing\n"
+    echo "$lint_outcome"
+    exit 1
+fi
+
+# If warnings, suggest they fix them
+if echo $lint_outcome | grep -q "warning"; then
+    echo "⚠️ [ precommit hook ] lint encountered warnings, consider fixing them before pushing\n"
+    echo "$lint_outcome"
+    exit 0
+fi
+
+echo "✅ [ precommit hook ] lint encountered no blocking issues\n"

package/.npmrc.bak

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

package/.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+	"i18n-ally.localesPaths": [
+		"public/locales"
+	],
+	"i18n-ally.keystyle": "nested",
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact"
+	],
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"editor.renderWhitespace": "all",
+	"editor.formatOnSave": true,
+	"eslint.format.enable": true,
+	"eslint.run": "onType",
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		"vite.config.js": "*.js,.babelrc,.nvmrc,index.html,.gitignore",
+		".env": ".env*,.*.json",
+		"firebase.json": "fire*,.fire*",
+		"package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml"
+	}
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Proof of Attendance Protocol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# Opinionated ESLint and VSCode style guide
+
+A shared set of standards and preferences, enforced through eslint and vscode. Priorities: minimalism, readability, documentation.
+
+## 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
+
+Lazy shell
+
+```shell
+npm install -D airier @babel/eslint-parser @babel/preset-react eslint eslint-plugin-react husky
+mkdir .vscode .husky
+
+# 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
+git add -f .eslintrc.js .babelrc .vscode/* .husky/*
+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
+```
+
+## Making changes
+
+The relevant source files are in `modules/`. If you make a change, you can update the package by:
+
+1. Making the changes
+1. Updating the version number in `package.json`
+1. Pushing to the main branch of the repo or opening a pull request. Changes are deployed and published through github actions. Publishing requires a version bump in `package.json`.
+
+### Using this repo as a template
+
+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 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

@@ -0,0 +1,7 @@
+const eslint_config = require( './modules/eslint_config.js' )
+const styleguide = require( './modules/styleguide.js' )
+
+module.exports = {
+    eslint_config,
+    styleguide
+}

package/modules/eslint_config.js

@@ -0,0 +1,56 @@
+const styleguide = require('./styleguide.js')
+
+module.exports = {
+
+    // Recommended features
+    "extends": [ "eslint:recommended", "plugin:react/recommended" ],
+
+    // Plugins
+    plugins: [ 'unused-imports' ],
+
+    // React settings
+    "settings": {
+        "react": { "version": "detect" }
+    },
+
+    // Parser features
+    parser: "@babel/eslint-parser",
+    parserOptions: {
+        requireConfigFile: false,
+        ecmaFeatures: {
+            jsx: true
+        }
+    },
+
+    // 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
+    },
+
+    // What environment to run in
+    env: {
+        node: true,
+        browser: true,
+        mocha: true,
+        jest: false,
+        es6: true
+    },
+
+    // What global variables should be assumed to exist
+    globals: {
+        context: true,
+        cy: true,
+        it: true,
+        Cypress: true,
+        expect: true
+    }
+
+}

package/modules/styleguide.js

@@ -0,0 +1,92 @@
+// Severity rationale:
+// none: we don't care about this at all
+// 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 = {
+
+    /* ///////////////////////////////
+    // Built-in rules
+    // /////////////////////////////*/
+
+    // No semi colons, note that "never" does not pose ASI hazard
+    "semi": [ "error", "never", ],
+
+    // Indentation setting
+    "indent": [ "warn", 4 ],
+
+    // Allow unnamed exports
+    "import/no-anonymous-default-export": 0,
+
+    // Prefer arrow callbacks
+    "prefer-arrow-callback": "warn",
+
+    // Do not mix spaces and tabs
+    "no-mixed-spaces-and-tabs": "error",
+
+    // Require spacing between brackets and keywords
+    "object-curly-spacing": [ "error", "always" ],
+    "array-bracket-spacing": [ "error", "always" ],
+    "block-spacing": [ "error", "always" ],
+    "space-before-blocks": [ "error", "always" ],
+    "brace-style": [ "error", "1tbs" ],
+    "keyword-spacing": [ "error", {
+        overrides: {
+            if: { after: false },
+            for: { after: false },
+            while: { after: false }
+        }
+    } ],
+    "arrow-spacing": "error",
+    "space-in-parens": [ "error", "always" ],
+    "template-curly-spacing": [ "error", "always" ],
+
+    // Comments need a space between // and the content. //Not like this.
+    "spaced-comment": [ "error", "always" ],
+
+    // Warn of template literal variables in the wrong place
+    "no-template-curly-in-string": "warn",
+
+    // Define things before using them
+    "no-use-before-define": [ "error", { functions: false } ],
+
+    // Only throw Error objects and not literals (like strings)
+    "no-throw-literal": "error",
+
+    // Prefer the use of destructuring
+    "prefer-destructuring": "warn",
+
+    // Warn of unused variables, function argumebnts may have documentation value so are ignored
+    "no-unused-vars": [ "warn", { vars: 'all', args: 'none' } ],
+
+    // No use of "var"
+    "no-var": "error",
+
+    // No unneeded ()
+    "no-extra-parens": "error",
+
+    // Regex control character matching, only warn since it is used in the most complete known email regex
+    "no-control-regex": "off",
+
+    // No unsafe usage
+    "no-unsafe-finally": "error",
+    "no-unsafe-optional-chaining": "error",
+    "no-unsafe-negation": "error",
+
+    /* ///////////////////////////////
+    // React plugin rules
+    // /////////////////////////////*/
+    "react/jsx-closing-bracket-location": [ "warn", "line-aligned" ],
+    "react/jsx-curly-brace-presence": [ "error", { props: "never", children: "never" } ],
+    "react/jsx-curly-newline": [ "error", "consistent" ],
+    "react/jsx-curly-spacing": [ "error", { when: "always", "children": true } ],
+    "react/jsx-indent": "warn",
+    "react/jsx-indent-props": "warn",
+    "react/jsx-no-useless-fragment": "error",
+
+    /* ///////////////////////////////
+    // Plugins
+    // /////////////////////////////*/
+    "unused-imports/no-unused-imports": "warn",
+
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "airier",
+  "version": "0.0.1",
+  "description": "Opinionated Eslint and VSCode style guide",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/actuallymentor/airier.git"
+  },
+  "author": "Mentor <mentor@palokaj.co> (http://github.com/actuallymentor)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/actuallymentor/airier/issues"
+  },
+  "homepage": "https://github.com/actuallymentor/airier#readme",
+  "devDependencies": {
+    "eslint-plugin-unused-imports": "^3.1.0"
+  }
+}