Feat: change getConfig to class for future extension

Author: JPeer264

__tests__/getConfig.js __tests__/Config.ts__tests__/getConfig.js renamed to __tests__/Config.ts

@@ -1,9 +1,9 @@
 import fs from 'fs-extra';
-import json from 'json-extra';
+import * as json from 'json-extra';
 import os from 'os';
 import path from 'path';
 
-import getConfig from '../lib/getConfig';
+import Config from '../lib/Config';
 
 const cwd = process.cwd();
 const homedir = os.homedir();
@@ -37,13 +37,13 @@ afterAll(() => {
 });
 
 it('read config from a specific path', () => {
-  expect(getConfig(fixtures)).toEqual(json.readToObjSync(path.join(fixtures, '.sgcrc')));
+  expect(new Config(fixtures).config).toEqual(json.readToObjSync(path.join(fixtures, '.sgcrc')));
 });
 
 it('read config from a .sgcrc_default', () => {
   const globalConfig = json.readToObjSync(path.join(cwd, '.sgcrc_default'));
 
-  expect(getConfig()).toEqual(globalConfig);
+  expect(new Config().config).toEqual(globalConfig);
 });
 
 it('read config from package.json', () => {
@@ -56,7 +56,7 @@ it('read config from package.json', () => {
   fs.renameSync(path.join(cwd, 'package.json'), path.join(cwd, `package.json.${randomString}-${datetime}.back`));
   fs.writeFileSync(path.join(cwd, 'package.json'), JSON.stringify(packageJson));
 
-  const config = getConfig();
+  const { config } = new Config();
 
   // revert local package
   fs.removeSync(path.join(cwd, 'package.json'));
@@ -69,29 +69,29 @@ it('read global config', () => {
   const sgcrc = json.readToObjSync(path.join(fixtures, '.sgcrc'));
 
   fs.writeFileSync(path.join(homedir, '.sgcrc'), JSON.stringify(sgcrc));
-  expect(getConfig()).toEqual(sgcrc);
+  expect(new Config().config).toEqual(sgcrc);
   fs.removeSync(path.join(homedir, '.sgcrc'));
 });
 
 it('read local config from `sgc.config.js`', () => {
   const sgcrc = json.readToObjSync(path.join(fixtures, '.sgcrc'));
 
   fs.writeFileSync(path.join(cwd, 'sgc.config.js'), `module.exports = (${JSON.stringify(sgcrc)})`);
-  expect(getConfig()).toEqual(sgcrc);
+  expect(new Config().config).toEqual(sgcrc);
   fs.removeSync(path.join(cwd, 'sgc.config.js'));
 });
 
 it('read global config from `sgc.config.js`', () => {
   const sgcrc = json.readToObjSync(path.join(fixtures, '.sgcrc'));
 
   fs.writeFileSync(path.join(homedir, 'sgc.config.js'), `module.exports = (${JSON.stringify(sgcrc)})`);
-  expect(getConfig()).toEqual(sgcrc);
+  expect(new Config().config).toEqual(sgcrc);
   fs.removeSync(path.join(homedir, 'sgc.config.js'));
 });
 
 it('read a .sgcrc_default from a deep nested cwd', () => {
   const deepCwd = path.join(fixtures, 'very', 'deep', 'directory');
   const fixturesConfig = json.readToObjSync(path.join(fixtures, '.sgcrc'));
 
-  expect(getConfig(deepCwd)).toEqual(fixturesConfig);
+  expect(new Config(deepCwd).config).toEqual(fixturesConfig);
 });

__tests__/cli.js

@@ -7,7 +7,7 @@ import cli from '../lib/cli';
 import sgcPrompt from '../lib/helpers/sgcPrompt';
 import retryCommit from '../lib/helpers/retryCommit';
 import promptOrInitialCommit from '../lib/helpers/promptOrInitialCommit';
-import getConfig from '../lib/getConfig';
+import Config from '../lib/Config';
 
 import pkg from '../package.json';
 
@@ -17,13 +17,11 @@ jest.mock('git-commit-count');
 jest.mock('../lib/helpers/sgcPrompt');
 jest.mock('../lib/helpers/retryCommit');
 jest.mock('../lib/helpers/promptOrInitialCommit');
-jest.mock('../lib/getConfig');
 
 beforeEach(() => {
   sgcPrompt.mockReset();
   retryCommit.mockReset();
   promptOrInitialCommit.mockReset();
-  getConfig.mockReset();
   console.log = jest.fn();
   console.error = jest.fn();
 });
@@ -61,7 +59,7 @@ it('should prompt init', async () => {
   isGit.mockReturnValue(true);
   isAdded.mockReturnValue(true);
   commitCount.mockReturnValue(0);
-  getConfig.mockReturnValue({ initialCommit: { isEnabled: true } });
+  jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({ initialCommit: { isEnabled: true } });
   await cli();
 
   expect(promptOrInitialCommit).toBeCalledTimes(1);
@@ -71,7 +69,7 @@ it('should not prompt init', async () => {
   isGit.mockReturnValue(true);
   isAdded.mockReturnValue(true);
   commitCount.mockReturnValue(0);
-  getConfig.mockReturnValue({ initialCommit: { isEnabled: false } });
+  jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({ initialCommit: { isEnabled: false } });
   await cli();
 
   expect(promptOrInitialCommit).not.toBeCalled();

__tests__/helper/commitMeetsRules.spec.ts

@@ -1,13 +1,9 @@
-import getConfig from '../../lib/getConfig';
+import Config from '../../lib/Config';
 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({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       types: [
         { type: 'Chore' },
       ],
@@ -18,8 +14,8 @@ describe('commitMeetsRules', () => {
     expect(commitMeetsRules('Chore    :   true')).toBe(false);
   });
 
-  it('should have one of the types', () => {
-    getConfigMock.mockReturnValue({
+  it('should have one of the types 2', () => {
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       lowercaseTypes: true,
       types: [
         { type: 'Chore' },
@@ -34,7 +30,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have one of the types with different delimiter', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       delimiter: ' -',
       types: [
         { type: 'Chore' },
@@ -49,7 +45,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should not have scope', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       scope: false,
       types: [
         { type: 'Feat' },
@@ -67,7 +63,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have optional scope', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       scope: true,
       types: [
         { type: 'Feat' },
@@ -84,7 +80,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have optional scope with scopespace', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       scope: true,
       addScopeSpace: true,
       types: [
@@ -102,7 +98,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have dot ending', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       rules: {
         endWithDot: true,
       },
@@ -118,7 +114,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have no dot ending', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       rules: {
         endWithDot: false,
       },
@@ -134,7 +130,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have correct length', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       rules: {
         maxChar: 10,
         minChar: 8,
@@ -152,7 +148,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have no length', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       types: [
         { type: 'Feat' },
       ],
@@ -166,7 +162,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have body', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       body: true,
       types: [
         { type: 'Feat' },
@@ -179,7 +175,7 @@ describe('commitMeetsRules', () => {
   });
 
   it('should have initial commit', () => {
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       initialCommit: {
         isEnabled: true,
         message: 'initial commit',
@@ -189,7 +185,7 @@ describe('commitMeetsRules', () => {
     expect(commitMeetsRules('initial commit')).toBe(true);
     expect(commitMeetsRules('Initial commit')).toBe(false);
 
-    getConfigMock.mockReturnValue({
+    jest.spyOn(Config.prototype, 'config', 'get').mockReturnValue({
       initialCommit: {
         isEnabled: false,
         message: 'initial commit',