package: initial implementation

Initial set of custom rules to enforce codestyle/patterns
we've adopted at LogDNA

* enforce sorted require declarations within modules
* enforce file extension for local modules/files
* enforce consistent aliases for tap assertions

Semver: major

Author: mdeltito

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+coverage/
+.nyc_output/
+.tap

.npmignore

@@ -0,0 +1,10 @@
+*.log
+npm-debug.log*
+coverage
+.nyc_output
+*.tgz
+.env
+*.swp
+*.vim
+.npm
+Jenkinsfile

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.taprc

@@ -0,0 +1,17 @@
+esm: false
+ts: false
+jsx: false
+check-coverage: true
+100: true
+reporter: classic
+nyc-arg:
+- --all=true
+- --exclude=test/
+output-file: .tap
+browser: false
+coverage-report:
+- text
+- text-summary
+- html
+files:
+- test/lib

Jenkinsfile

@@ -0,0 +1,160 @@
+library 'magic-butler-catalogue'
+
+def PROJECT_NAME = "eslint-plugin-logdna"
+def REPO = "logdna/${PROJECT_NAME}"
+def TRIGGER_PATTERN = ".*@logdnabot.*"
+
+pipeline {
+  agent none
+
+  options {
+    timestamps()
+    ansiColor 'xterm'
+  }
+
+  triggers {
+    issueCommentTrigger(TRIGGER_PATTERN)
+  }
+
+  stages {
+    stage('Validate PR Source') {
+      when {
+        expression { env.CHANGE_FORK }
+        not {
+          triggeredBy 'issueCommentCause'
+        }
+      }
+      steps {
+        error("A maintainer needs to approve this PR for CI by commenting")
+      }
+    }
+
+    stage('Test Suite') {
+      matrix {
+        axes {
+          axis {
+            name 'NODE_VERSION'
+            values '10', '12', '14'
+          }
+        }
+
+        agent {
+          docker {
+            image "us.gcr.io/logdna-k8s/node:${NODE_VERSION}-ci"
+          }
+        }
+
+        environment {
+          NPM_CONFIG_CACHE = '.npm'
+          NPM_CONFIG_USERCONFIG = '.npm/rc'
+          SPAWN_WRAP_SHIM_ROOT = '.npm'
+        }
+
+        stages {
+          stage('Install') {
+
+            steps {
+              sh 'mkdir -p .npm'
+              sh """
+              npm install
+              """
+            }
+          }
+
+          stage('Test') {
+            steps {
+              sh 'node -v'
+              sh 'npm -v'
+              sh 'npm test'
+            }
+
+            post {
+              always {
+                sh 'cat .tap | ./node_modules/.bin/tap-mocha-reporter xunit > coverage/test.xml'
+
+                junit 'coverage/test.xml'
+
+                publishHTML target: [
+                  allowMissing: false,
+                  alwaysLinkToLastBuild: false,
+                  keepAll: true,
+                  reportDir: 'coverage/lcov-report',
+                  reportFiles: 'index.html',
+                  reportName: "coverage-node-v${NODE_VERSION}"
+                ]
+              }
+            }
+          }
+        }
+      }
+    }
+
+    stage('Test Release') {
+      when {
+        beforeAgent true
+        not {
+          branch 'master'
+        }
+      }
+
+      agent {
+        docker {
+          image "us.gcr.io/logdna-k8s/node:12-ci"
+          customWorkspace "${PROJECT_NAME}-${BUILD_NUMBER}"
+        }
+      }
+
+      environment {
+        GITHUB_PACKAGES_TOKEN = credentials('github-api-token')
+        NPM_CONFIG_CACHE = '.npm'
+        NPM_CONFIG_USERCONFIG = '.npm/rc'
+        SPAWN_WRAP_SHIM_ROOT = '.npm'
+      }
+
+      steps {
+        sh 'mkdir -p .npm'
+        versioner(
+          token: "${GITHUB_PACKAGES_TOKEN}"
+        , dry: true
+        , repo: REPO
+        , branch: "master"
+        )
+      }
+    }
+
+    stage('Release') {
+      when {
+        beforeAgent true
+        branch 'master'
+      }
+
+      agent {
+        docker {
+          image "us.gcr.io/logdna-k8s/node:12-ci"
+          customWorkspace "${PROJECT_NAME}-${BUILD_NUMBER}"
+        }
+      }
+
+      environment {
+        NPM_CONFIG_CACHE = '.npm'
+        NPM_CONFIG_USERCONFIG = '.npm/rc'
+        SPAWN_WRAP_SHIM_ROOT = '.npm'
+        GITHUB_PACKAGES_TOKEN = credentials('github-api-token')
+        NPM_PUBLISH_TOKEN = credentials('npm-publish-token')
+      }
+
+      steps {
+        sh 'mkdir -p .npm'
+        sh "git checkout -b ${GIT_BRANCH} origin/${GIT_BRANCH}"
+
+        versioner(
+          token: "${GITHUB_PACKAGES_TOKEN}"
+        , dry: false
+        , repo: REPO
+        , NPM_PUBLISH_TOKEN: "${NPM_PUBLISH_TOKEN}"
+        , branch: "master"
+        )
+      }
+    }
+  }
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2020 LogDNA
+
+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

@@ -1,2 +1,121 @@
-# eslint-plugin-logdna
+# `eslint-plugin-logdna`
 
+> ESlint plugin containing a collection of rules for enforcing code style at LogDNA
+
+## Installation
+
+**Requires eslint also**
+
+We do not use peer dependencies, so make sure that `eslint` is also installed as a dev dependency.
+
+```shell
+npm install eslint-plugin-logdna eslint --save-dev
+```
+
+## Usage
+
+Add `logdna` to the plugins section of your ESLint configuration. You can omit 
+the `eslint-plugin-` prefix. Then you can configure the rules you want to use:
+
+```json
+{
+  "plugins": [
+    "logdna"
+  ],
+  "rules": {
+    "logdna/grouped-require": "error",
+    "logdna/require-file-extension": "error",
+    "logdna/tap-consistent-assertions": {
+      "preferredMap": {
+        "equal": "strictEqual"
+      }
+    }
+  }
+}
+```
+
+## Rules
+
+### `logdna/grouped-require`
+
+Enforce sorted require declarations within modules
+
+```js
+// Bad
+const foo = require('./lib/foo.js') //local
+const http = require('http') // builtin
+require('foo') // static
+const logger = require('@logdna/logger') // scoped
+const tap = require('tap') // contrib
+
+// Good
+require('foo') // static
+const http = require('http') // builtin
+const tap = require('tap') // contrib
+const logger = require('@logdna/logger') // scoped
+const foo = require('./lib/foo.js') //local
+```
+
+#### Options
+
+* `typeOrder` [`<Array>`][] - sort order of require types 
+(default: `['static', 'builtin', 'contrib', 'scoped', 'local']`)
+
+### `logdna/tap-consistent-assertions`
+
+Enforce consistent aliases for tap assertions
+
+```js
+// {
+//   "plugins": [
+//     "logdna"
+//   ],
+//   "rules": {
+//     "logdna/tap-consistent-assertions": {
+//       "preferredMap": {
+//         "equal": "strictEqual"
+//       }
+//     }
+//   }
+// }
+
+// Bad
+test('foo', async (t) => {
+  t.is_equal(1, 1)
+  t.equal(1, 1)
+  t.identical(1, 1)
+})
+
+// Good
+test('foo', async (t) => {
+  t.strictEqual(1, 1)
+  t.strictEqual(1, 1)
+  t.strictEqual(1, 1)
+})
+```
+
+#### Options
+* `preferredMap` [`<Object>`][] -  maps the "primary" assertion method to the preferred alias
+* `calleePattern` [`<String>`][] - pattern to match for tap's `Test` object (default: `/^t+$/`)
+
+### `logdna/require-file-extension`
+
+Enforce file extension for local modules/files
+
+```js
+// Bad
+const foo = require('./lib/foo')
+
+// Good
+const foo = require('./lib/foo.js')
+```
+
+## License
+
+Copyright © [LogDNA](https://logdna.com), released under an MIT license. See the [LICENSE](./LICENSE) file and https://opensource.org/licenses/MIT
+
+*Happy Logging!*
+
+[`<Object>`]: https://mdn.io/object
+[`<String>`]: https://mdn.io/string
+[`<Array>`]: https://mdn.io/array

lib/common/require-type.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const isBuiltinModule = require('is-builtin-module')
+const {get} = require('dot-prop')
+
+module.exports = {
+  isRequire
+, isStaticRequire
+, isBuiltin
+, isScoped
+, isLocal
+, isTopLevel
+}
+
+function isRequire(node) {
+  const value = get(node, 'declarations.0.init.callee.name')
+  return !!(value && value === 'require')
+}
+
+function isStaticRequire(node) {
+  if (!node || node.type !== 'CallExpression') return false
+  const calleeType = get(node, 'callee.type')
+  const calleeName = get(node, 'callee.name')
+
+  return (
+    node.arguments.length === 1
+      && calleeType === 'Identifier'
+      && calleeName === 'require'
+  )
+}
+
+function isScoped(node) {
+  const value = get(node, 'declarations.0.init.arguments.0.value')
+  return !!(value && value.startsWith('@'))
+}
+
+function isBuiltin(node) {
+  const value = get(node, 'declarations.0.init.arguments.0.value')
+  return !!(value && isBuiltinModule(value))
+}
+
+function isLocal(node) {
+  const value = get(node, 'declarations.0.init.arguments.0.value')
+  return !!(value && value.startsWith('.'))
+}
+
+function isTopLevel(node) {
+  const value = get(node, 'parent.type')
+  return !!(value && value === 'Program')
+}