Add eslint, husky, oxlint, and tap

Author: jdalton

.gitignore

@@ -3,6 +3,7 @@
 Thumbs.db
 /.env
 /.nvm
+/.tap
 /.vscode
 /npm-debug.log
 /yarn.lock

.husky/pre-commit

@@ -0,0 +1 @@
+npm test

.oxlintrc.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["import", "promise", "typescript", "unicorn"],
+  "categories": {
+    "correctness": "warn",
+    "perf": "warn",
+    "suspicious": "warn"
+  },
+  "settings": {},
+  "rules": {
+    "@typescript-eslint/no-misused-new": ["deny"],
+    "@typescript-eslint/no-this-alias": ["deny"],
+    "unicorn/no-empty-file": "allow",
+    "unicorn/no-new-array": "allow",
+    "no-control-regex": "allow",
+    "no-extend-native": "allow",
+    "no-new": "allow",
+    "no-self-assign": "allow",
+    "no-unused-vars": "allow"
+  }
+}

.prettierrc

@@ -1,7 +1,7 @@
 {
-  "arrowParens": "avoid",
-  "semi": false,
-  "singleQuote": true,
-  "trailingComma": "none",
-  "proseWrap": "always"
+    "arrowParens": "avoid",
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "proseWrap": "always"
 }

.taprc

@@ -0,0 +1,10 @@
+# vim: set filetype=yaml :
+allow-incomplete-coverage: true
+color: true
+coverage-report:
+  - none
+disable-coverage: true
+include:
+  - test/**/*.test.js
+passes: false
+reporter: base

.travis.yml

@@ -1,11 +1,11 @@
 language: node_js
 node_js:
-  - lts/*
-  - 17
-  - 16
-  - 15
-  - 14
-  - 13
-  - 12
-  - 11
-  - 10
+    - lts/*
+    - 17
+    - 16
+    - 15
+    - 14
+    - 13
+    - 12
+    - 11
+    - 10

eslint.config.js

@@ -0,0 +1,103 @@
+'use strict'
+
+const path = require('node:path')
+
+const { includeIgnoreFile } = require('@eslint/compat')
+const js = require('@eslint/js')
+const importXPlugin = require('eslint-plugin-import-x')
+const nodePlugin = require('eslint-plugin-n')
+const sortDestructureKeysPlugin = require('eslint-plugin-sort-destructure-keys')
+const unicornPlugin = require('eslint-plugin-unicorn')
+
+const constants = require('@socketsecurity/registry/lib/constants')
+const { GIT_IGNORE, PRETTIER_IGNORE } = constants
+
+const rootPath = __dirname
+
+const gitignorePath = path.resolve(rootPath, GIT_IGNORE)
+const prettierignorePath = path.resolve(rootPath, PRETTIER_IGNORE)
+
+module.exports = [
+    includeIgnoreFile(gitignorePath),
+    includeIgnoreFile(prettierignorePath),
+    {
+        files: ['**/*.{c,}js'],
+        ...importXPlugin.flatConfigs.recommended,
+        languageOptions: {
+            ...importXPlugin.flatConfigs.recommended.languageOptions,
+            ecmaVersion: 'latest',
+            sourceType: 'script'
+        },
+        rules: {
+            ...importXPlugin.flatConfigs.recommended.rules,
+            'import-x/no-named-as-default-member': 'off',
+            'import-x/no-unresolved': ['error', { commonjs: true }],
+            'import-x/order': [
+                'warn',
+                {
+                    groups: [
+                        'builtin',
+                        'external',
+                        'internal',
+                        ['parent', 'sibling', 'index'],
+                        'type'
+                    ],
+                    pathGroups: [
+                        {
+                            pattern: '@socket{registry,security}/**',
+                            group: 'internal'
+                        }
+                    ],
+                    pathGroupsExcludedImportTypes: ['type'],
+                    'newlines-between': 'always',
+                    alphabetize: {
+                        order: 'asc'
+                    }
+                }
+            ]
+        }
+    },
+    {
+        files: ['scripts/**/*.js', 'test/**/*.cjs'],
+        ...nodePlugin.configs['flat/recommended-script']
+    },
+    {
+        files: ['scripts/**/*.js', 'test/**/*.cjs'],
+        plugins: {
+            'sort-destructure-keys': sortDestructureKeysPlugin,
+            unicorn: unicornPlugin
+        },
+        rules: {
+            ...js.configs.recommended.rules,
+            'n/exports-style': ['error', 'module.exports'],
+            // The n/no-unpublished-bin rule does does not support non-trivial glob
+            // patterns used in package.json "files" fields. In those cases we simplify
+            // the glob patterns used.
+            'n/no-unpublished-bin': ['error'],
+            'n/no-unsupported-features/es-builtins': ['error'],
+            'n/no-unsupported-features/es-syntax': ['error'],
+            'n/no-unsupported-features/node-builtins': [
+                'error',
+                {
+                    ignores: ['test', 'test.describe'],
+                    // Lazily access constants.maintainedNodeVersions.
+                    version: constants.maintainedNodeVersions.previous
+                }
+            ],
+            'n/prefer-node-protocol': ['error'],
+            'no-await-in-loop': ['error'],
+            'no-control-regex': ['error'],
+            'no-empty': ['error', { allowEmptyCatch: true }],
+            'no-new': ['error'],
+            'no-proto': ['error'],
+            'no-unused-vars': [
+                'error',
+                { argsIgnorePattern: '^_|^this$', ignoreRestSiblings: true }
+            ],
+            'no-warning-comments': ['warn', { terms: ['fixme'] }],
+            'sort-destructure-keys/sort-destructure-keys': ['error'],
+            'sort-imports': ['error', { ignoreDeclarationSort: true }],
+            'unicorn/consistent-function-scoping': ['error']
+        }
+    }
+]

index.js

@@ -22,15 +22,15 @@ SOFTWARE.
 'use strict'
 
 const {
-  PackageURL,
-  PurlComponent,
-  PurlQualifierNames,
-  PurlType
+    PackageURL,
+    PurlComponent,
+    PurlQualifierNames,
+    PurlType
 } = require('./src/package-url')
 
 module.exports = {
-  PackageURL,
-  PurlComponent,
-  PurlQualifierNames,
-  PurlType
+    PackageURL,
+    PurlComponent,
+    PurlQualifierNames,
+    PurlType
 }