Feat: check commits by command (closes #88) (#90)

Author: JPeer264

.eslintrc.js

@@ -16,9 +16,33 @@ module.exports = {
     ecmaVersion: 2018,
     sourceType: 'module',
   },
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.ts'],
+      },
+    },
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        'no-dupe-class-members': 'off',
+      },
+    },
+  ],
   plugins: [
     '@typescript-eslint',
   ],
   rules: {
-  },
+    '@typescript-eslint/explicit-function-return-type': ['warn', {
+      allowTypedFunctionExpressions: true,
+      allowExpressions: true,
+    }],
+    'import/extensions': ['error', 'ignorePackages', {
+      js: 'never',
+      ts: 'never',
+    }],
+    'no-shadow-restricted-names': 'off',
+  }
 };

README.md

@@ -117,6 +117,19 @@ Then, update the  `semantic-release ` script to your `package.json` to this :
 }
 ```
 
+## Commands
+
+### check
+
+This will check all commits and will fail if your commits do not meet the defined config.
+
+**Flags**
+  - `start`: A commit SHA to start, in case you started using `sgc` later of your development
+
+```sh
+$ sgc check --start 84a1abd
+```
+
 ## Config
 
 > Just create a `.sgcrc` in your project root or you can add everything in your `package.json` with the value `sgc`

__tests__/check.spec.ts

@@ -0,0 +1,63 @@
+import gitCommitRange from 'git-commit-range';
+import chalk from 'chalk';
+
+import check from '../lib/check';
+
+jest.mock('git-commit-range', jest.fn);
+
+const gitCommitRangeMock = gitCommitRange as jest.MockedFunction<typeof gitCommitRange>;
+
+describe('check', () => {
+  beforeEach(() => {
+    global.process.exit = jest.fn() as any;
+    global.console.error = jest.fn() as any;
+
+    chalk.enabled = false;
+  });
+
+  it('should have valid commits', () => {
+    gitCommitRangeMock.mockReturnValue([
+      'Feat: should be valid',
+    ]);
+
+    check();
+
+    expect(process.exit).toBeCalledTimes(1);
+    expect(process.exit).toBeCalledWith(0);
+
+    check();
+
+    expect(process.exit).toBeCalledTimes(2);
+    expect(process.exit).toBeCalledWith(0);
+  });
+
+  it('should have valid initial commits', () => {
+    gitCommitRangeMock.mockReturnValue([
+      'Feat: should be valid',
+      'Initial commit',
+    ]);
+
+    check();
+
+    expect(process.exit).toBeCalledTimes(1);
+    expect(process.exit).toBeCalledWith(0);
+  });
+
+  it('should have invalid commits', () => {
+    gitCommitRangeMock.mockReturnValue([
+      'NotValid : should be valid',
+    ]);
+
+    check();
+
+    expect(process.exit).toBeCalledTimes(1);
+    expect(process.exit).toBeCalledWith(1);
+    // eslint-disable-next-line no-console
+    expect(console.error).toBeCalledWith('\nNotVali\nNotValid : should be valid');
+
+    check();
+
+    expect(process.exit).toBeCalledTimes(2);
+    expect(process.exit).toBeCalledWith(1);
+  });
+});

__tests__/helper/commitMeetsRules.spec.ts

@@ -0,0 +1,202 @@
+import getConfig from '../../lib/getConfig';
+import commitMeetsRules from '../../lib/helpers/commitMeetsRules';
+
+jest.mock('../../lib/getConfig', jest.fn);
+
+const getConfigMock = getConfig as jest.MockedFunction<typeof getConfig>;
+
+describe('commitMeetsRules', () => {
+  it('should have one of the types', () => {
+    getConfigMock.mockReturnValue({
+      types: [
+        { type: 'Chore' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat: false')).toBe(false);
+    expect(commitMeetsRules('Chore: true')).toBe(true);
+    expect(commitMeetsRules('Chore    :   true')).toBe(false);
+  });
+
+  it('should have one of the types', () => {
+    getConfigMock.mockReturnValue({
+      lowercaseTypes: true,
+      types: [
+        { type: 'Chore' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat: false')).toBe(false);
+    expect(commitMeetsRules('feat: false')).toBe(false);
+    expect(commitMeetsRules('chore: true')).toBe(true);
+    expect(commitMeetsRules('Chore: true')).toBe(false);
+    expect(commitMeetsRules('chore    :   true')).toBe(false);
+  });
+
+  it('should have one of the types with different delimiter', () => {
+    getConfigMock.mockReturnValue({
+      delimiter: ' -',
+      types: [
+        { type: 'Chore' },
+        { type: 'Fix' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat - false')).toBe(false);
+    expect(commitMeetsRules('Fix - false')).toBe(true);
+    expect(commitMeetsRules('Chore - true')).toBe(true);
+    expect(commitMeetsRules('Chore    :   true')).toBe(false);
+  });
+
+  it('should not have scope', () => {
+    getConfigMock.mockReturnValue({
+      scope: false,
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat(scope): Test')).toBe(false);
+    expect(commitMeetsRules('Feat (scope): Test')).toBe(false);
+    expect(commitMeetsRules('Feat (scope)  : Test')).toBe(false);
+    expect(commitMeetsRules('Feat: Test')).toBe(true);
+    expect(commitMeetsRules('Feat: Test (scope at the end)')).toBe(true);
+    expect(commitMeetsRules('Feat : Test')).toBe(false);
+    expect(commitMeetsRules('Feat:    Test  ')).toBe(true);
+    expect(commitMeetsRules('Feat  : Test')).toBe(false);
+  });
+
+  it('should have optional scope', () => {
+    getConfigMock.mockReturnValue({
+      scope: true,
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat(scope): Test')).toBe(true);
+    expect(commitMeetsRules('Feat (scope): Test')).toBe(false);
+    expect(commitMeetsRules('Feat (scope)  : Test')).toBe(false);
+    expect(commitMeetsRules('Feat: Test')).toBe(true);
+    expect(commitMeetsRules('Feat : Test')).toBe(false);
+    expect(commitMeetsRules('Feat:    Test  ')).toBe(true);
+    expect(commitMeetsRules('Feat  : Test')).toBe(false);
+  });
+
+  it('should have optional scope with scopespace', () => {
+    getConfigMock.mockReturnValue({
+      scope: true,
+      addScopeSpace: true,
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat(scope): Test')).toBe(false);
+    expect(commitMeetsRules('Feat (scope): Test')).toBe(true);
+    expect(commitMeetsRules('Feat (scope)  : Test')).toBe(false);
+    expect(commitMeetsRules('Feat: Test')).toBe(true);
+    expect(commitMeetsRules('Feat : Test')).toBe(false);
+    expect(commitMeetsRules('Feat:    Test  ')).toBe(true);
+    expect(commitMeetsRules('Feat  : Test')).toBe(false);
+  });
+
+  it('should have dot ending', () => {
+    getConfigMock.mockReturnValue({
+      rules: {
+        endWithDot: true,
+      },
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat: Test.')).toBe(true);
+    expect(commitMeetsRules('Feat: Test')).toBe(false);
+    expect(commitMeetsRules('Feat   : Test.')).toBe(false);
+    expect(commitMeetsRules('Feat   : Test')).toBe(false);
+  });
+
+  it('should have no dot ending', () => {
+    getConfigMock.mockReturnValue({
+      rules: {
+        endWithDot: false,
+      },
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat: Test')).toBe(true);
+    expect(commitMeetsRules('Feat: Test.')).toBe(false);
+    expect(commitMeetsRules('Feat   : Test.')).toBe(false);
+    expect(commitMeetsRules('Feat   : Test')).toBe(false);
+  });
+
+  it('should have correct length', () => {
+    getConfigMock.mockReturnValue({
+      rules: {
+        maxChar: 10,
+        minChar: 8,
+      },
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat: T')).toBe(false);
+    expect(commitMeetsRules('Feat: Te')).toBe(true);
+    expect(commitMeetsRules('Feat: Tes')).toBe(true);
+    expect(commitMeetsRules('Feat: Test')).toBe(true);
+    expect(commitMeetsRules('Feat: Test1')).toBe(false);
+  });
+
+  it('should have no length', () => {
+    getConfigMock.mockReturnValue({
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Feat: T')).toBe(true);
+    expect(commitMeetsRules('Feat: Te')).toBe(true);
+    expect(commitMeetsRules('Feat: Tes')).toBe(true);
+    expect(commitMeetsRules('Feat: Test')).toBe(true);
+    expect(commitMeetsRules('Feat: Test1')).toBe(true);
+  });
+
+  it('should have body', () => {
+    getConfigMock.mockReturnValue({
+      body: true,
+      types: [
+        { type: 'Feat' },
+      ],
+    });
+
+    expect(commitMeetsRules('Chore: T\n\nmy body in here')).toBe(false);
+    expect(commitMeetsRules('Feat: T\n\nmy body in here')).toBe(true);
+    expect(commitMeetsRules('Feat: T\ninvalid body in here')).toBe(false);
+  });
+
+  it('should have initial commit', () => {
+    getConfigMock.mockReturnValue({
+      initialCommit: {
+        isEnabled: true,
+        message: 'initial commit',
+      },
+    });
+
+    expect(commitMeetsRules('initial commit')).toBe(true);
+    expect(commitMeetsRules('Initial commit')).toBe(false);
+
+    getConfigMock.mockReturnValue({
+      initialCommit: {
+        isEnabled: false,
+        message: 'initial commit',
+      },
+    });
+
+    expect(commitMeetsRules('initial commit')).toBe(false);
+    expect(commitMeetsRules('Initial commit')).toBe(false);
+  });
+});

global.d.ts

@@ -0,0 +1,2 @@
+declare module 'git-commit-range';
+declare module 'chalk';

lib/check.ts

@@ -0,0 +1,37 @@
+import gitCommitRange from 'git-commit-range';
+import chalk from 'chalk';
+
+import commitMeetsRules from './helpers/commitMeetsRules';
+
+const check = ({ start }: { start?: string } = {}): void => {
+  const commitRangeText: string[] = gitCommitRange({
+    from: start,
+    type: 'text',
+    includeMerges: false,
+  });
+  const commitRangeSha: string[] = gitCommitRange({
+    from: start,
+    includeMerges: false,
+  });
+
+  let hasErrors = false;
+
+  commitRangeText.forEach((commit, i) => {
+    const isCommitValid = commitMeetsRules(commit);
+
+    if (!isCommitValid) {
+      const commitSha = commitRangeSha[i].slice(0, 7);
+
+      hasErrors = true;
+
+      // eslint-disable-next-line no-console
+      console.error(chalk.red(`\n${chalk.bold(commitSha)}\n${commit}`));
+    }
+
+    return isCommitValid;
+  });
+
+  process.exit(+hasErrors);
+};
+
+export default check;