Merge pull request #117 from egorAva/feature/cli-options

feat: added the ability to add cli options

README.md

@@ -175,3 +175,37 @@ After this run Jest in watch mode and you will see the following line in your wa
 ```
  › Press F to override Stylelint --fix.
 ```
+
+## Options
+
+This project uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig), so you can provide config via:
+
+- a `jest-runner-stylelint` property in your `package.json`
+- a `jest-runner-stylelint.config.js` JS file
+- a `.jest-runner-stylelintrc` JSON file
+
+In `package.json`
+
+```json
+{
+  "jest-runner-stylelint": {
+    "cliOptions": {
+      // Options here
+    }
+  }
+}
+```
+
+or in `jest-runner-stylelint.config.js`
+
+```js
+module.exports = {
+  cliOptions: {
+    // Options here
+  }
+};
+```
+
+### cliOptions
+
+Follow the [stylelint documentation on configuration](https://stylelint.io/user-guide/cli#options) to create your cli options.

package.json

@@ -58,6 +58,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.1.0",
     "@commitlint/config-conventional": "^8.1.0",
+    "cosmiconfig": "^6.0.0",
     "eslint": "^6.8.0",
     "eslint-config-starstuff": "^1.4.5",
     "husky": "^4.0.0",

src/__fixtures__/jest-runner-stylelint.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  cliOptions: {
+    allowEmptyInput: true
+  }
+};

src/run.js

@@ -1,16 +1,20 @@
 const { pass, fail } = require("create-jest-runner");
 const stylelint = require("stylelint");
 const configOverrides = require("./configOverrides");
+const getCliOptions = require("./utils/getCliOptions");
 
-module.exports = ({ testPath }) => {
+module.exports = ({ testPath, config }) => {
   const start = new Date();
 
+  const defaultConfig = {
+    files: testPath,
+    formatter: "string",
+    fix: configOverrides.getFix()
+  };
+  const { cliOptions = {} } = getCliOptions(config);
+
   return stylelint
-    .lint({
-      files: testPath,
-      formatter: "string",
-      fix: configOverrides.getFix()
-    })
+    .lint(Object.assign({}, cliOptions, defaultConfig))
     .then(data => {
       if (data.errored) {
         return fail({

src/utils/__tests__/getCliOptions.test.js

@@ -0,0 +1,18 @@
+const getCliOptions = require("../getCliOptions");
+const path = require("path");
+
+describe("getCliOptions", () => {
+  it("check cli options in jest-runner-stylelint.config", () => {
+    const rootDir = path.resolve(__dirname, "../../__fixtures__");
+    const config = getCliOptions({ rootDir });
+
+    expect(config).toEqual({ cliOptions: { allowEmptyInput: true } });
+  });
+
+  it("check cli options without config", () => {
+    const rootDir = path.resolve(__dirname, "./");
+    const config = getCliOptions({ rootDir });
+
+    expect(config).toEqual({ cliOptions: {} });
+  });
+});

src/utils/__tests__/normalizeConfig.test.js

@@ -0,0 +1,14 @@
+const normalizeConfig = require("../normalizeConfig");
+
+describe("normalizeConfig", () => {
+  it("check cliOptions", () => {
+    const config = normalizeConfig({ cliOptions: { arg: "test arg" } });
+    expect(config).toEqual({ cliOptions: { arg: "test arg" } });
+  });
+
+  it("check default cliOptions", () => {
+    const config = normalizeConfig({});
+
+    expect(config).toEqual({ cliOptions: {} });
+  });
+});

src/utils/getCliOptions.js

@@ -0,0 +1,13 @@
+const { cosmiconfigSync } = require("cosmiconfig");
+const normalizeConfig = require("./normalizeConfig");
+
+const explorerSync = cosmiconfigSync("jest-runner-stylelint");
+
+const getCliOptions = ({ rootDir }) => {
+  const result = explorerSync.search(rootDir);
+  const config = result === null ? {} : result.config;
+
+  return normalizeConfig(config);
+};
+
+module.exports = getCliOptions;

src/utils/normalizeConfig.js

@@ -0,0 +1,7 @@
+const normalizeConfig = config => {
+  return Object.assign({}, config, {
+    cliOptions: config.cliOptions || {}
+  });
+};
+
+module.exports = normalizeConfig;