@form8ion/eslint-config-extender 2.0.0-alpha.2 → 3.0.0

package/README.md

@@ -30,6 +30,7 @@
 [![MIT license][license-badge]][license-link]
 [![npm][npm-badge]][npm-link]
 [![Try @form8ion/eslint-config-extender on RunKit][runkit-badge]][runkit-link]
+![node][node-badge]
 
 <!--consumer-badges end -->
 
@@ -44,7 +45,10 @@ $ npm install @form8ion/eslint-config-extender --save-prod
 #### Import
 
 ```javascript
-import {scaffold, extendEslintConfig} from '@form8ion/eslint-config-extender';
+const {packageManagers} = require('@form8ion/javascript-core');
+const {questionNames: projectQuestionNames} = require('@form8ion/project');
+const {scaffold: javascriptScaffolder, questionNames: jsQuestionNames} = require('@form8ion/javascript');
+const {scaffold, extendEslintConfig} = require('@form8ion/eslint-config-extender');
 ```
 
 #### Execute
@@ -66,8 +70,33 @@ import {scaffold, extendEslintConfig} from '@form8ion/eslint-config-extender';
 ```javascript
 (async () => {
   await extendEslintConfig(
-    {options: 'for the project-scaffolder'},
-    decisions => javascriptScaffolder({options: 'for the js-scaffolder', decisions})
+    {
+      decisions: {
+        [projectQuestionNames.PROJECT_NAME]: 'eslint-config-foo',
+        [projectQuestionNames.DESCRIPTION]: 'a description of the project',
+        [projectQuestionNames.VISIBILITY]: 'Public',
+        [projectQuestionNames.LICENSE]: 'MIT',
+        [projectQuestionNames.COPYRIGHT_HOLDER]: 'John Smith',
+        [projectQuestionNames.COPYRIGHT_YEAR]: '2022',
+        [projectQuestionNames.GIT_REPO]: true,
+        [projectQuestionNames.REPO_HOST]: 'GitHub',
+        [projectQuestionNames.REPO_OWNER]: 'org-name',
+        [jsQuestionNames.AUTHOR_NAME]: 'John Smith',
+        [jsQuestionNames.AUTHOR_EMAIL]: 'john@smith.org',
+        [jsQuestionNames.AUTHOR_URL]: 'https://smith.org',
+        [jsQuestionNames.SCOPE]: 'org-name',
+        [jsQuestionNames.PACKAGE_MANAGER]: packageManagers.NPM,
+        [jsQuestionNames.NODE_VERSION_CATEGORY]: 'LTS',
+        [jsQuestionNames.CI_SERVICE]: 'Other'
+      },
+      vcsHosts: {
+        GitHub: {
+          scaffolder: options => options,
+          prompt: ({decisions}) => ({[projectQuestionNames.REPO_OWNER]: decisions[projectQuestionNames.REPO_OWNER]})
+        }
+      }
+    },
+    decisions => options => javascriptScaffolder({...options, decisions, unitTestFrameworks: {}})
   );
 })();
 ```
@@ -136,3 +165,5 @@ $ npm test
 [github-actions-ci-link]: https://github.com/form8ion/eslint-config-extender/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
 
 [github-actions-ci-badge]: https://github.com/form8ion/eslint-config-extender/workflows/Node.js%20CI/badge.svg
+
+[node-badge]: https://img.shields.io/node/v/@form8ion/eslint-config-extender?logo=node.js

package/example.js

@@ -1,11 +1,31 @@
 // #### Import
-// remark-usage-ignore-next 2
+// remark-usage-ignore-next 4
+import {resolve} from 'path';
 import stubbedFs from 'mock-fs';
-import {scaffold as javascriptScaffolder} from '@form8ion/javascript';
-import {scaffold, extendEslintConfig} from './lib/index.js';
+import td from 'testdouble';
+import any from '@travi/any';
+
+// remark-usage-ignore-next 12
+const stubbedNodeModules = stubbedFs.load(resolve('node_modules'));
+const error = new Error('Command failed with exit code 1: npm ls husky --json');
+error.exitCode = 1;
+error.stdout = JSON.stringify({});
+error.command = 'npm ls husky --json';
+const execa = td.replace('execa');
+td.when(execa('. ~/.nvm/nvm.sh && nvm ls-remote --lts', {shell: true}))
+  .thenResolve({stdout: ['v16.5.4', ''].join('\n')});
+td.when(execa('. ~/.nvm/nvm.sh && nvm install', {shell: true})).thenReturn({stdout: {pipe: () => undefined}});
+td.when(execa('npm', ['ls', 'husky', '--json'])).thenReject(error);
+td.when(execa('npm run generate:md && npm test', {shell: true})).thenReturn({stdout: {pipe: () => undefined}});
+td.when(execa('npm', ['whoami'])).thenResolve({stdout: any.word()});
+
+const {packageManagers} = require('@form8ion/javascript-core');
+const {questionNames: projectQuestionNames} = require('@form8ion/project');
+const {scaffold: javascriptScaffolder, questionNames: jsQuestionNames} = require('@form8ion/javascript');
+const {scaffold, extendEslintConfig} = require('./lib/index.js');
 
 // remark-usage-ignore-next
-stubbedFs();
+stubbedFs({node_modules: stubbedNodeModules});
 
 // #### Execute
 
@@ -23,7 +43,32 @@ stubbedFs();
 
 (async () => {
   await extendEslintConfig(
-    {options: 'for the project-scaffolder'},
-    decisions => javascriptScaffolder({options: 'for the js-scaffolder', decisions})
+    {
+      decisions: {
+        [projectQuestionNames.PROJECT_NAME]: 'eslint-config-foo',
+        [projectQuestionNames.DESCRIPTION]: 'a description of the project',
+        [projectQuestionNames.VISIBILITY]: 'Public',
+        [projectQuestionNames.LICENSE]: 'MIT',
+        [projectQuestionNames.COPYRIGHT_HOLDER]: 'John Smith',
+        [projectQuestionNames.COPYRIGHT_YEAR]: '2022',
+        [projectQuestionNames.GIT_REPO]: true,
+        [projectQuestionNames.REPO_HOST]: 'GitHub',
+        [projectQuestionNames.REPO_OWNER]: 'org-name',
+        [jsQuestionNames.AUTHOR_NAME]: 'John Smith',
+        [jsQuestionNames.AUTHOR_EMAIL]: 'john@smith.org',
+        [jsQuestionNames.AUTHOR_URL]: 'https://smith.org',
+        [jsQuestionNames.SCOPE]: 'org-name',
+        [jsQuestionNames.PACKAGE_MANAGER]: packageManagers.NPM,
+        [jsQuestionNames.NODE_VERSION_CATEGORY]: 'LTS',
+        [jsQuestionNames.CI_SERVICE]: 'Other'
+      },
+      vcsHosts: {
+        GitHub: {
+          scaffolder: options => options,
+          prompt: ({decisions}) => ({[projectQuestionNames.REPO_OWNER]: decisions[projectQuestionNames.REPO_OWNER]})
+        }
+      }
+    },
+    decisions => options => javascriptScaffolder({...options, decisions, unitTestFrameworks: {}})
   );
 })();

package/package.json

@@ -2,11 +2,14 @@
   "name": "@form8ion/eslint-config-extender",
   "description": "shareable ESLint config scaffolder for extending another config",
   "license": "MIT",
-  "version": "2.0.0-alpha.2",
+  "version": "3.0.0",
   "files": [
     "example.js",
     "lib/"
   ],
+  "engines": {
+    "node": "^14.15 || ^16"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -49,21 +52,22 @@
     "test:unit": "cross-env NODE_ENV=test c8 run-s test:unit:base",
     "test:unit:base": "DEBUG=any mocha 'src/**/*-test.js'",
     "lint:peer": "npm ls >/dev/null",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "lint:engines": "ls-engines"
   },
   "devDependencies": {
     "@babel/register": "7.17.7",
-    "@cucumber/cucumber": "8.2.0",
-    "@form8ion/babel-preset": "1.6.87",
-    "@form8ion/commitlint-config": "1.0.31",
-    "@form8ion/eslint-config": "5.0.2",
+    "@cucumber/cucumber": "8.2.1",
+    "@form8ion/babel-preset": "1.6.89",
+    "@form8ion/commitlint-config": "1.0.33",
+    "@form8ion/eslint-config": "5.0.3",
     "@form8ion/eslint-config-cucumber": "1.4.1",
     "@form8ion/eslint-config-mocha": "2.0.1",
     "@form8ion/remark-lint-preset": "4.0.0",
     "@travi/any": "2.0.20",
     "@travi/github-scaffolder": "8.0.1",
     "ban-sensitive-files": "1.9.18",
-    "c8": "7.11.2",
+    "c8": "7.11.3",
     "chai": "4.3.6",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",
@@ -72,6 +76,7 @@
     "husky": "8.0.1",
     "js-yaml": "4.1.0",
     "lockfile-lint": "4.7.4",
+    "ls-engines": "0.6.6",
     "mocha": "10.0.0",
     "mock-fs": "5.1.2",
     "nock": "13.2.4",
@@ -81,7 +86,7 @@
     "remark-toc": "8.0.1",
     "remark-usage": "10.0.1",
     "rimraf": "3.0.2",
-    "rollup": "2.72.1",
+    "rollup": "2.74.1",
     "rollup-plugin-auto-external": "2.0.0",
     "sinon": "14.0.0",
     "testdouble": "3.16.5"
@@ -89,7 +94,7 @@
   "dependencies": {
     "@form8ion/javascript": "^4.0.0",
     "@form8ion/javascript-core": "^5.0.0",
-    "@form8ion/project": "^12.0.0",
+    "@form8ion/project": "^13.1.0",
     "deepmerge": "^4.2.2",
     "write-yaml": "^1.0.0"
   }