feat: port lint script from @npmcli/lint (#8)

* feat: port lint script from `@npmcli/lint`

* chore: use @npmcli/template-oss

Author: Luke Karrys

.eslintrc.js

@@ -0,0 +1,14 @@
+// This file is automatically added by @npmcli/template-oss. Do not edit.
+
+const { readdirSync: readdir } = require('fs')
+
+const localConfigs = readdir(__dirname)
+  .filter((file) => file.startsWith('.eslintrc.local.'))
+  .map((file) => `./${file}`)
+
+module.exports = {
+  extends: [
+    '@npmcli',
+    ...localConfigs,
+  ],
+}

.eslintrc.local.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["./lib/index.js"]
+}

.github/CODEOWNERS

@@ -0,0 +1 @@
+*	@npm/cli-team

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,54 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Bug
+description: File a bug/issue
+title: "[BUG] <title>"
+labels: [Bug, Needs Triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please [search here](./issues) to see if an issue already exists for your problem.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A clear & concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A clear & concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    value: |
+      1. In this environment...
+      2. With this config...
+      3. Run '...'
+      4. See error...
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **npm**: 7.6.3
+        - **Node**: 13.14.0
+        - **OS**: Ubuntu 20.04
+        - **platform**: Macbook Pro
+    value: |
+        - npm:
+        - Node:
+        - OS:
+        - platform:
+  validations:
+    required: false
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,3 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+blank_issues_enabled: true

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
 name: CI
 
 on:
@@ -8,33 +10,45 @@ on:
       - latest
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          cache: npm
+      - run: npm i --prefer-online -g npm@latest
+      - run: npm ci
+      - run: npm run lint
+
+  test:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.x]
+        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.13.0, 16.x]
         platform:
         - os: ubuntu-latest
           shell: bash
         - os: macos-latest
           shell: bash
         - os: windows-latest
           shell: bash
+        - os: windows-latest
+          shell: cmd
         - os: windows-latest
           shell: powershell
-
     runs-on: ${{ matrix.platform.os }}
     defaults:
       run:
         shell: ${{ matrix.platform.shell }}
-
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          cache: npm
           node-version: ${{ matrix.node-version }}
+          cache: npm
       - run: npm i --prefer-online -g npm@latest
       - run: npm ci
-      - run: npm test
+      - run: npm test --ignore-scripts
       - run: npm ls -a

.gitignore

@@ -1,7 +1,10 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
 # ignore everything in the root
 /*
 
 # keep these
+!/.eslintrc*
 !/.github
 !**/.gitignore
 !/package.json
@@ -13,3 +16,4 @@
 !/test
 !/README*
 !/LICENSE*
+!/SECURITY*

LICENSE.md

@@ -1,3 +1,5 @@
+<!-- This file is automatically added by @npmcli/template-oss. Do not edit. -->
+
 ISC License
 
 Copyright npm, Inc.

README.md

@@ -26,3 +26,13 @@ module.exports = {
 
 This allows any overrides for a project to exist in a separate file, typically
 `.eslintrc.local.json`.
+
+#### `bin`
+
+This module also contains a bin script that will run `eslint` with the bundled config.
+
+```
+npm i -D @npmcli/eslint-config
+
+# lint with our style rules
+npx @npmcli/eslint-config -- # any args to eslint go here...`

SECURITY.md

@@ -0,0 +1,3 @@
+<!-- This file is automatically added by @npmcli/template-oss. Do not edit. -->
+
+Please send vulnerability reports through [hackerone](https://hackerone.com/github).

bin/index.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require('child_process')
+const { sync: whichSync } = require('which')
+const { resolve } = require('path')
+const eslintrc = resolve(__dirname, '../lib/index.js')
+const args = ['-c', eslintrc, ...process.argv.slice(2)]
+const result = spawnSync(whichSync('eslint'), args, { stdio: 'inherit' })
+process.exitCode = result.exitCode

lib/index.js

@@ -2,19 +2,19 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2018,
     ecmaFeatures: {},
-    sourceType: 'script'
+    sourceType: 'script',
   },
   env: {
     es6: true,
-    node: true
+    node: true,
   },
   plugins: [
     'node',
   ],
   globals: {
     document: 'readonly',
     navigator: 'readonly',
-    window: 'readonly'
+    window: 'readonly',
   },
   rules: {
     'accessor-pairs': 'error',
@@ -28,7 +28,7 @@ module.exports = {
       objects: 'always-multiline',
       imports: 'always-multiline',
       exports: 'always-multiline',
-      functions: 'never'
+      functions: 'never',
     }],
     'comma-spacing': ['error', { before: false, after: true }],
     'comma-style': ['error', 'last'],
@@ -41,7 +41,7 @@ module.exports = {
     eqeqeq: ['error', 'always', { null: 'ignore' }],
     'func-call-spacing': ['error', 'never'],
     'generator-star-spacing': ['error', { before: true, after: true }],
-    'handle-callback-err': ['error', '^(err|error)$' ],
+    'handle-callback-err': ['error', '^(err|error)$'],
     indent: ['error', 2, {
       SwitchCase: 1,
       VariableDeclarator: 1,
@@ -55,7 +55,7 @@ module.exports = {
       ImportDeclaration: 1,
       flatTernaryExpressions: true,
       ignoreComments: false,
-      ignoredNodes: ['TemplateLiteral *']
+      ignoredNodes: ['TemplateLiteral *'],
     }],
     'key-spacing': ['error', { beforeColon: false, afterColon: true }],
     'keyword-spacing': ['error', { before: true, after: true }],
@@ -139,7 +139,9 @@ module.exports = {
     'no-unreachable': 'error',
     'no-unsafe-finally': 0,
     'no-unsafe-negation': 'error',
-    'no-unused-expressions': ['error', { allowShortCircuit: true, allowTernary: true, allowTaggedTemplates: true }],
+    'no-unused-expressions': ['error', {
+      allowShortCircuit: true, allowTernary: true, allowTaggedTemplates: true,
+    }],
     'no-unused-vars': ['error', { vars: 'all', args: 'none', ignoreRestSiblings: true }],
     'no-use-before-define': ['error', { functions: false, classes: false, variables: false }],
     'no-useless-call': 'error',
@@ -158,7 +160,7 @@ module.exports = {
     'one-var': ['error', { initialized: 'never' }],
     'operator-linebreak': 'off',
     'padded-blocks': ['error', { blocks: 'never', switches: 'never', classes: 'never' }],
-    'prefer-const': ['error', { destructuring: 'all'} ],
+    'prefer-const': ['error', { destructuring: 'all' }],
     'prefer-promise-reject-errors': 'error',
     'quote-props': ['error', 'as-needed'],
     quotes: ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],
@@ -172,7 +174,11 @@ module.exports = {
     'space-unary-ops': ['error', { words: true, nonwords: false }],
     'spaced-comment': ['error', 'always', {
       line: { markers: ['*package', '!', '/', ',', '='] },
-      block: { balanced: true, markers: ['*package', '!', ',', ':', '::', 'flow-include'], exceptions: ['*'] }
+      block: {
+        balanced: true,
+        markers: ['*package', '!', ',', ':', '::', 'flow-include'],
+        exceptions: ['*'],
+      },
     }],
     'symbol-description': 'error',
     'template-curly-spacing': ['error', 'never'],
@@ -188,5 +194,5 @@ module.exports = {
     'node/no-deprecated-api': 'error',
     'node/process-exit-as-throw': 'error',
     'node/no-callback-literal': 'error',
-  }
+  },
 }