build: port execute-rule to ts

Author: marionebl

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

@commitlint/execute-rule/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib";

@commitlint/execute-rule/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib');

@commitlint/execute-rule/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+	preset: 'ts-jest',
+	testEnvironment: 'node'
+};

@commitlint/execute-rule/package.json

@@ -7,31 +7,12 @@
     "lib/"
   ],
   "scripts": {
-    "build": "cross-env NODE_ENV=production babel src --out-dir lib  --source-maps",
+    "build": "tsc",
     "deps": "dep-check",
     "pkg": "pkg-check",
-    "start": "concurrently \"ava -c 4 --verbose --watch\" \"yarn run watch\"",
-    "test": "ava -c 4 --verbose",
-    "watch": "babel src --out-dir lib --watch --source-maps"
-  },
-  "ava": {
-    "files": [
-      "src/**/*.test.js",
-      "!lib/**/*"
-    ],
-    "source": [
-      "src/**/*.js",
-      "!lib/**/*"
-    ],
-    "babel": "inherit",
-    "require": [
-      "babel-register"
-    ]
-  },
-  "babel": {
-    "presets": [
-      "babel-preset-commitlint"
-    ]
+    "start": "concurrently \"yarn test --watchAll\" \"yarn run watch\"",
+    "test": "jest",
+    "watch": "tsc -w"
   },
   "engines": {
     "node": ">=4"
@@ -57,16 +38,12 @@
   "license": "MIT",
   "devDependencies": {
     "@commitlint/parse": "^7.5.0",
-    "@commitlint/test": "7.6.0",
     "@commitlint/utils": "^7.5.0",
-    "ava": "0.22.0",
-    "babel-cli": "6.26.0",
-    "babel-preset-commitlint": "^7.5.0",
-    "babel-register": "6.26.0",
+    "@types/jest": "24.0.13",
+    "@types/lodash": "4.14.130",
     "concurrently": "3.5.1",
-    "cross-env": "5.1.1"
-  },
-  "dependencies": {
-    "babel-runtime": "6.26.0"
+    "jest": "24.8.0",
+    "ts-jest": "24.0.2",
+    "typescript": "3.4.5"
   }
-}
+}

@commitlint/execute-rule/src/index.js

@@ -0,0 +1,26 @@
+import execute from '.';
+
+test('does nothing without params', async () => {
+	const exec = execute as any;
+	expect(await exec()).toBeNull();
+});
+
+test('returns plain config', async () => {
+	const actual = await execute(['name', 'config']);
+	expect(actual).toEqual(['name', 'config']);
+});
+
+test('unwraps promised config', async () => {
+	const actual = await execute(['name', Promise.resolve('config')]);
+	expect(actual).toEqual(['name', 'config']);
+});
+
+test('executes config functions', async () => {
+	const actual = await execute(['name', () => 'config']);
+	expect(actual).toEqual(['name', 'config']);
+});
+
+test('executes async config functions', async () => {
+	const actual = await execute(['name', async () => 'config']);
+	expect(actual).toEqual(['name', 'config']);
+});

@commitlint/execute-rule/src/index.test.js

@@ -0,0 +1,25 @@
+type Rule<T> = readonly [string, Config<T>];
+type Config<T> = T | Promise<T> | ExectableConfig<T>;
+type ExectableConfig<T> = (() => T) | (() => Promise<T>);
+
+type ExecutedRule<T> = readonly [string, T];
+
+export default execute;
+
+export async function execute<T = unknown>(rule: Rule<T>): Promise<ExecutedRule<T> | null> {
+	if (!Array.isArray(rule)) {
+		return null;
+	}
+
+	const [name, config] = rule;
+
+	const fn = executable(config) 
+		? config
+		: async () => config;
+	
+	return [name, await fn()];
+};
+
+function executable<T>(config: Config<T>): config is ExectableConfig<T> {
+	return typeof config === 'function';
+}

@commitlint/execute-rule/src/index.test.ts

@@ -0,0 +1,22 @@
+{
+	"compilerOptions": {
+		"lib": [
+			"dom",
+			"es2015"
+		],
+		"rootDir": "src",
+		"outDir": "lib",
+		"declaration": true,
+		"declarationMap": true,
+		"sourceMap": true,
+		"esModuleInterop": true,
+		"allowSyntheticDefaultImports": true,
+		"strict": true
+	},
+	"include": [
+		"./src"
+	],
+	"exclude": [
+		"./src/**/*.test.ts"
+	]
+}

@commitlint/execute-rule/src/index.ts

@@ -37,12 +37,10 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/test": "7.6.0",
     "@commitlint/utils": "^7.5.0",
     "@types/jest": "24.0.13",
     "@types/lodash": "4.14.130",
     "concurrently": "3.5.1",
-    "cross-env": "5.1.1",
     "jest": "24.8.0",
     "rimraf": "2.6.1",
     "ts-jest": "24.0.2",

@commitlint/execute-rule/tsconfig.json

@@ -8517,6 +8517,13 @@ rimraf@2, rimraf@^2.2.8, rimraf@^2.5.1, rimraf@^2.5.2, rimraf@^2.5.4, rimraf@^2.
   dependencies:
     glob "^7.0.5"
 
+[email protected]:
+  version "2.6.1"
+  resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.6.1.tgz#c2338ec643df7a1b7fe5c54fa86f57428a55f33d"
+  integrity sha1-wjOOxkPfeht/5cVPqG9XQopV8z0=
+  dependencies:
+    glob "^7.0.5"
+
 rimraf@^2.6.3:
   version "2.6.3"
   resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz#b2d104fe0d8fb27cf9e0a1cda8262dd3833c6cab"