Merge pull request #530 from form8ion/alpha

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm test

package.json

@@ -41,7 +41,8 @@
     "test:integration:base": "DEBUG=any cucumber-js test/integration --profile base",
     "test:integration:debug": "NODE_OPTIONS=--enable-source-maps DEBUG=test run-s test:integration",
     "test:integration:wip": "run-s 'test:integration:base -- --profile wip'",
-    "test:integration:focus": "run-s 'test:integration:base -- --profile focus'"
+    "test:integration:focus": "run-s 'test:integration:base -- --profile focus'",
+    "prepare": "husky install"
   },
   "devDependencies": {
     "@babel/register": "7.13.16",
@@ -82,6 +83,7 @@
   },
   "dependencies": {
     "@form8ion/core": "^1.3.1",
+    "@form8ion/eslint": "1.0.0-alpha.4",
     "@form8ion/husky": "1.2.0",
     "@form8ion/javascript-core": "^2.9.2",
     "@travi/cli-messages": "^1.0.4",

src/lift-test.js

@@ -1,10 +1,10 @@
 import * as huskyLifter from '@form8ion/husky';
+import * as eslint from '@form8ion/eslint';
 import deepmerge from 'deepmerge';
 import sinon from 'sinon';
 import any from '@travi/any';
 import {assert} from 'chai';
 import * as packageLifter from './package';
-import * as eslintLifter from './eslint/lift';
 import * as packageManagerResolver from './package-manager';
 import lift from './lift';
 
@@ -34,7 +34,7 @@ suite('lift', () => {
     sandbox = sinon.createSandbox();
 
     sandbox.stub(packageLifter, 'default');
-    sandbox.stub(eslintLifter, 'default');
+    sandbox.stub(eslint, 'lift');
     sandbox.stub(packageManagerResolver, 'default');
     sandbox.stub(huskyLifter, 'lift');
 
@@ -53,7 +53,7 @@ suite('lift', () => {
       nextSteps: eslintNextSteps,
       devDependencies: eslintDevDependencies
     };
-    eslintLifter.default.withArgs({configs: eslintConfigs, scope, projectRoot}).resolves(eslintLiftResults);
+    eslint.lift.withArgs({configs: eslintConfigs, projectRoot}).resolves(eslintLiftResults);
 
     const liftResults = await lift({projectRoot, results, configs: {eslint: {scope}}});
 
@@ -66,21 +66,4 @@ suite('lift', () => {
       )
     );
   });
-
-  test('that eslint-configs are not processed if configs are not provided', async () => {
-    const liftResults = await lift({projectRoot, results});
-
-    assert.deepEqual(liftResults, {});
-
-    assert.calledWith(
-      packageLifter.default,
-      deepmerge({projectRoot, scripts, tags, dependencies, devDependencies, packageManager}, huskyLiftResults)
-    );
-  });
-
-  test('that eslint-configs are not processed if config for eslint is not provided', async () => {
-    const liftResults = await lift({projectRoot, results, configs: any.simpleObject()});
-
-    assert.deepEqual(liftResults, {});
-  });
 });

src/lift.js

@@ -1,56 +1,37 @@
-import {info, warn} from '@travi/cli-messages';
+import {info} from '@travi/cli-messages';
 import deepmerge from 'deepmerge';
 import {lift as liftHusky} from '@form8ion/husky';
+import {lift as liftEslint} from '@form8ion/eslint';
 import liftPackage from './package';
-import liftEslint from './eslint';
 import resolvePackageManager from './package-manager';
 
-function configIsProvidedForEslint(configs) {
-  return configs && configs.eslint;
-}
-
 export default async function ({
   projectRoot,
-  configs,
   results: {scripts, tags, eslintConfigs, dependencies, devDependencies, packageManager: manager}
 }) {
   info('Lifting JavaScript-specific details');
 
   const packageManager = await resolvePackageManager({projectRoot, packageManager: manager});
   const huskyResults = await liftHusky({projectRoot, packageManager});
-
-  if (configIsProvidedForEslint(configs)) {
-    const {
-      nextSteps,
-      devDependencies: eslintDevDependencies
-    } = await liftEslint({configs: eslintConfigs, scope: configs.eslint.scope, projectRoot});
-
-    await liftPackage(
-      deepmerge(
-        {
-          projectRoot,
-          scripts,
-          tags,
-          dependencies,
-          devDependencies,
-          packageManager,
-          eslintDevDependencies
-        },
-        huskyResults
-      )
-    );
-
-    return {nextSteps};
-  }
-
-  if (eslintConfigs) warn('Config for ESLint not provided. Skipping ESLint configuration');
+  const {
+    nextSteps,
+    devDependencies: eslintDevDependencies
+  } = await liftEslint({projectRoot, configs: eslintConfigs});
 
   await liftPackage(
     deepmerge(
-      {projectRoot, scripts, tags, dependencies, devDependencies, packageManager},
+      {
+        projectRoot,
+        scripts,
+        tags,
+        dependencies,
+        devDependencies,
+        packageManager,
+        eslintDevDependencies
+      },
       huskyResults
     )
   );
 
-  return {};
+  return {nextSteps};
 }

test/integration/features/eslint-configs.feature

@@ -2,14 +2,34 @@ Feature: ESLint Configs
 
   Scenario: No existing config
     Given no existing eslint config file is present
-    And "npm" is the package manager
-    And husky is not installed
+    And an "npm" lockfile exists
+    And husky v5 is installed
     When the scaffolder results are processed
     Then no eslint config file exists
 
   Scenario: existing yaml config
     Given an existing eslint config file is present
-    And "npm" is the package manager
-    And husky is not installed
+    And an "npm" lockfile exists
+    And husky v5 is installed
     When the scaffolder results are processed
     Then the yaml eslint config file contains the expected config
+
+  Scenario: existing yaml config and shareable configs to add
+    Given an existing eslint config file is present
+    And an "npm" lockfile exists
+    And husky v5 is installed
+    And additional shareable configs are provided
+    When the scaffolder results are processed
+    Then the yaml eslint config file contains the expected config
+    And the next-steps are provided
+    And dependencies are defined for the additional configs
+
+  Scenario: existing yaml config and complex shareable configs to add
+    Given an existing eslint config file is present
+    And an "npm" lockfile exists
+    And husky v5 is installed
+    And complex additional shareable configs are provided
+    When the scaffolder results are processed
+    Then the yaml eslint config file contains the expected config
+    And the next-steps are provided
+    And dependencies are defined for the additional configs

test/integration/features/husky.feature

@@ -2,15 +2,15 @@ Feature: Husky
 
   Scenario: Husky v5 installed, v4 config
     Given husky v5 is installed
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And husky config is in v4 format
     When the scaffolder results are processed
     Then husky is configured for "npm"
     And the v4 config is removed
 
   Scenario: Husky v5 installed, v4 config
     Given husky v5 is installed
-    And "yarn" is the package manager
+    And an "yarn" lockfile exists
     And husky config is in v4 format
     When the scaffolder results are processed
     Then husky is configured for "yarn"
@@ -34,14 +34,14 @@ Feature: Husky
 
   Scenario: Husky v5 installed, v5 config
     Given husky v5 is installed
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And husky config is in v5 format
     When the scaffolder results are processed
     Then the next-steps do not include a warning about the husky config
 
   Scenario: Husky v4 installed, v4 config
     Given husky v4 is installed
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And husky config is in v4 format
     When the scaffolder results are processed
     Then the next-steps do not include a warning about the husky config

test/integration/features/package-properties.feature

@@ -2,15 +2,15 @@ Feature: Package Properties
 
   Scenario: Tags results when no existing keywords
     Given there are no existing keywords
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And tags are provided in the results
     And husky is not installed
     When the scaffolder results are processed
     Then keywords from the results exist
 
   Scenario: Tags results when some keywords exist
     Given there are existing keywords
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And tags are provided in the results
     And husky is not installed
     When the scaffolder results are processed

test/integration/features/scripts.feature

@@ -2,23 +2,23 @@ Feature: Scripts
 
   Scenario: No Additional Scripts from Results
     Given no additional scripts are included in the results
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And husky is not installed
     When the scaffolder results are processed
     Then the existing scripts still exist
     And no extra scripts were added
 
   Scenario: Additional Scripts Are Present in Results
     Given additional scripts are included in the results
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And husky is not installed
     When the scaffolder results are processed
     Then the existing scripts still exist
     And the additional scripts exist
 
   Scenario: Duplicate Scripts Are Present in Results
     Given additional scripts that duplicate existing scripts are included in the results
-    And "npm" is the package manager
+    And an "npm" lockfile exists
     And husky is not installed
     When the scaffolder results are processed
     Then the additional scripts exist