Merge branch 'release/3.1.0'

.github/workflows/publish.yaml

@@ -0,0 +1,22 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@sixxgate'
+      - run: yarn
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,6 +1,12 @@
+# Package manager outputs
 node_modules/
-dist/
 npm-shrinkwrap.json
 package-lock.json
 pnpm-lock.yaml
 yarn.lock
+
+# Build outputs
+dist/
+
+# Test packages
+**/*.tgz

LICENSE

@@ -0,0 +1,19 @@
+Copyright 2023 Matthew Holder
+
+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.

README.md

@@ -0,0 +1,46 @@
+# Quick and Easy Opinionated ESLint Setup
+
+Provides a strict, quick, and easy to setup opinionated ESLint rule set for;
+- JavaScript
+- TypeScript
+- Node.js
+- Vue.
+
+These rulesets are loosely based on Standard JS and Standard TS.
+
+The setup should use a `.eslintrc.cjs` file.
+
+Example:
+
+```js
+'use strict'
+const { defineConfig } = require('./dist/index.cjs')
+
+module.exports = defineConfig(({ useNode, useTypeScript }) => {
+  // Enable these rulesets:
+  useNode()
+  useTypeScript('./tsconfig.json')
+
+  // Additions and everrides for ESLint.
+  return {
+    root: true,
+    env: { es2021: true },
+    reportUnusedDisableDirectives: true
+  }
+})
+```
+
+Support function from `defineConfig`.
+- `useNode`
+- `useTypeScript`
+- `useVue`
+
+JavaScript is always supported by default.
+
+The following ESLint plug-ins are:
+- `prettier`
+- `n`
+- `import`
+- `promise`
+- `typescript`
+- `vue`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sixxgate/lint",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "packageManager": "[email protected]",
   "main": "dist/index.cjs",
   "author": "Matthew Holder <[email protected]>",
@@ -18,9 +18,11 @@
     "lint": "eslint .",
     "fix": "eslint --fix .",
     "prepare": "husky install",
-    "prepack": "npm run build"
+    "prepack": "yarn run rebuild"
   },
   "files": [
+    "README.md",
+    "LICENSE",
     "dist/**/*.d.ts",
     "dist/**/*.d.cts",
     "dist/**/*.d.mts",