stylelint-webpack-plugin 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.1.0](https://github.com/webpack-contrib/stylelint-webpack-plugin/compare/v1.2.3...v2.1.0) (2020-06-17)
+
+
+### Features
+
+* support typescript ([#213](https://github.com/webpack-contrib/stylelint-webpack-plugin/issues/213)) ([b7dfa19](https://github.com/webpack-contrib/stylelint-webpack-plugin/commit/b7dfa195b7836bad7ac94a64a0c0a6163021a3e7))
+
 ## [2.0.0](https://github.com/webpack-contrib/stylelint-webpack-plugin/compare/v1.2.3...v2.0.0) (2020-05-04)
 
 ### ⚠ BREAKING CHANGES

package/declarations/LintDirtyModulesPlugin.d.ts

@@ -0,0 +1,58 @@
+/** @typedef {import('webpack').Compiler} Compiler */
+/** @typedef {import('./getOptions').Options} Options */
+/** @typedef {import('./linter').Lint} Lint */
+/** @typedef {import('./linter').LinterCallback} LinterCallback */
+/** @typedef {Partial<{timestamp:number} | number>} FileSystemInfoEntry */
+export default class LintDirtyModulesPlugin {
+  /**
+   * @param {Lint} lint
+   * @param {Compiler} compiler
+   * @param {Options} options
+   */
+  constructor(lint: Lint, compiler: Compiler, options: Options);
+  lint: import('./linter').Lint;
+  compiler: import('webpack').Compiler;
+  options: import('./getOptions').Options;
+  startTime: number;
+  prevTimestamps: Map<any, any>;
+  isFirstRun: boolean;
+  /**
+   * @param {Compiler} compilation
+   * @param {LinterCallback} callback
+   * @returns {void}
+   */
+  apply(compilation: Compiler, callback: LinterCallback): void;
+  /**
+   * @param {Map<string, number>} fileTimestamps
+   * @param {string | ReadonlyArray<string>} glob
+   * @returns {Array<string>}
+   */
+  getChangedFiles(
+    fileTimestamps: Map<string, number>,
+    glob: string | ReadonlyArray<string>
+  ): Array<string>;
+}
+export type Compiler = import('webpack').Compiler;
+export type Options = {
+  context?: string | undefined;
+  emitError?: boolean | undefined;
+  emitWarning?: boolean | undefined;
+  failOnError?: boolean | undefined;
+  failOnWarning?: boolean | undefined;
+  files: string | string[];
+  formatter: TimerHandler;
+  lintDirtyModulesOnly?: boolean | undefined;
+  quiet?: boolean | undefined;
+  stylelintPath: string;
+};
+export type Lint = (
+  options: import('./getOptions').Options
+) => Promise<import('stylelint').LinterResult>;
+export type LinterCallback = (
+  error?: import('./StylelintError').default | null | undefined
+) => void;
+export type FileSystemInfoEntry =
+  | number
+  | Partial<{
+      timestamp: number;
+    }>;

package/declarations/StylelintError.d.ts

@@ -0,0 +1,30 @@
+/** @typedef {import('stylelint').LintResult} LintResult */
+/** @typedef {import('./getOptions').Options} Options */
+export default class StylelintError extends Error {
+  /**
+   * @param {Options} options
+   * @param {Array<LintResult>} messages
+   * @returns {StylelintError}
+   */
+  static format(
+    { formatter }: Options,
+    messages: Array<LintResult>
+  ): StylelintError;
+  /**
+   * @param {Partial<string>} messages
+   */
+  constructor(messages: Partial<string>);
+}
+export type LintResult = import('stylelint').LintResult;
+export type Options = {
+  context?: string | undefined;
+  emitError?: boolean | undefined;
+  emitWarning?: boolean | undefined;
+  failOnError?: boolean | undefined;
+  failOnWarning?: boolean | undefined;
+  files: string | string[];
+  formatter: TimerHandler;
+  lintDirtyModulesOnly?: boolean | undefined;
+  quiet?: boolean | undefined;
+  stylelintPath: string;
+};

package/declarations/cjs.d.ts

@@ -0,0 +1,2 @@
+declare const _exports: typeof import('.').default;
+export = _exports;

package/declarations/getOptions.d.ts

@@ -0,0 +1,32 @@
+/** @typedef {import("stylelint")} stylelint */
+/**
+ * @typedef {Object} Options
+ * @property {string=} context
+ * @property {boolean=} emitError
+ * @property {boolean=} emitWarning
+ * @property {boolean=} failOnError
+ * @property {boolean=} failOnWarning
+ * @property {Array<string> | string} files
+ * @property {Function | string} formatter
+ * @property {boolean=} lintDirtyModulesOnly
+ * @property {boolean=} quiet
+ * @property {string} stylelintPath
+ */
+/**
+ * @param {Partial<Options>} pluginOptions
+ * @returns {Options}
+ */
+export default function getOptions(pluginOptions: Partial<Options>): Options;
+export type stylelint = typeof import('stylelint');
+export type Options = {
+  context?: string | undefined;
+  emitError?: boolean | undefined;
+  emitWarning?: boolean | undefined;
+  failOnError?: boolean | undefined;
+  failOnWarning?: boolean | undefined;
+  files: Array<string> | string;
+  formatter: Function | string;
+  lintDirtyModulesOnly?: boolean | undefined;
+  quiet?: boolean | undefined;
+  stylelintPath: string;
+};

package/declarations/index.d.ts

@@ -0,0 +1,18 @@
+export default StylelintWebpackPlugin;
+export type Compiler = import('webpack').Compiler;
+/** @typedef {import('webpack').Compiler} Compiler */
+declare class StylelintWebpackPlugin {
+  constructor(options?: {});
+  options: import('./getOptions').Options;
+  /**
+   * @param {Compiler} compiler
+   * @returns {void}
+   */
+  apply(compiler: Compiler): void;
+  /**
+   *
+   * @param {Compiler} compiler
+   * @returns {string}
+   */
+  getContext(compiler: Compiler): string;
+}

package/declarations/linter.d.ts

@@ -0,0 +1,47 @@
+/** @typedef {import('stylelint').LinterResult} LinterResult */
+/** @typedef {import('stylelint').LintResult} LintResult */
+/** @typedef {import('webpack').Compiler} Compiler */
+/** @typedef {import('./getOptions').Options} Options */
+/**
+ * @callback Lint
+ * @param {Options} options
+ * @returns {Promise<LinterResult>}
+ */
+/**
+ * @callback LinterCallback
+ * @param {StylelintError | null=} error
+ * @returns {void}
+ */
+/**
+ * @param {Lint} lint
+ * @param {Options} options
+ * @param {Compiler} compiler
+ * @param {LinterCallback} callback
+ * @returns {void}
+ */
+export default function linter(
+  lint: Lint,
+  options: Options,
+  compiler: Compiler,
+  callback: LinterCallback
+): void;
+export type LinterResult = import('stylelint').LinterResult;
+export type LintResult = import('stylelint').LintResult;
+export type Compiler = import('webpack').Compiler;
+export type Options = {
+  context?: string | undefined;
+  emitError?: boolean | undefined;
+  emitWarning?: boolean | undefined;
+  failOnError?: boolean | undefined;
+  failOnWarning?: boolean | undefined;
+  files: string | string[];
+  formatter: TimerHandler;
+  lintDirtyModulesOnly?: boolean | undefined;
+  quiet?: boolean | undefined;
+  stylelintPath: string;
+};
+export type Lint = (options: Options) => Promise<LinterResult>;
+export type LinterCallback = (
+  error?: (StylelintError | null) | undefined
+) => void;
+import StylelintError from './StylelintError';

package/declarations/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @param {Array<string> | string} files
+ * @param {string} context
+ * @returns {Array<string>}
+ */
+export function parseFiles(
+  files: Array<string> | string,
+  context: string
+): Array<string>;
+/**
+ * @param {string} str
+ * @returns {string}
+ */
+export function replaceBackslashes(str: string): string;

package/dist/LintDirtyModulesPlugin.js

@@ -13,15 +13,35 @@ var _utils = require("./utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/** @typedef {import('webpack').Compiler} Compiler */
+
+/** @typedef {import('./getOptions').Options} Options */
+
+/** @typedef {import('./linter').Lint} Lint */
+
+/** @typedef {import('./linter').LinterCallback} LinterCallback */
+
+/** @typedef {Partial<{timestamp:number} | number>} FileSystemInfoEntry */
 class LintDirtyModulesPlugin {
+  /**
+   * @param {Lint} lint
+   * @param {Compiler} compiler
+   * @param {Options} options
+   */
   constructor(lint, compiler, options) {
     this.lint = lint;
     this.compiler = compiler;
     this.options = options;
     this.startTime = Date.now();
-    this.prevTimestamps = {};
+    this.prevTimestamps = new Map();
     this.isFirstRun = true;
   }
+  /**
+   * @param {Compiler} compilation
+   * @param {LinterCallback} callback
+   * @returns {void}
+   */
+
 
   apply(compilation, callback) {
     const fileTimestamps = compilation.fileTimestamps || new Map();
@@ -34,7 +54,8 @@ class LintDirtyModulesPlugin {
     }
 
     const dirtyOptions = { ...this.options
-    };
+    }; // @ts-ignore
+
     const glob = (0, _utils.replaceBackslashes)(dirtyOptions.files.join('|'));
     const changedFiles = this.getChangedFiles(fileTimestamps, glob);
     this.prevTimestamps = fileTimestamps;
@@ -46,11 +67,34 @@ class LintDirtyModulesPlugin {
       callback();
     }
   }
+  /**
+   * @param {Map<string, number>} fileTimestamps
+   * @param {string | ReadonlyArray<string>} glob
+   * @returns {Array<string>}
+   */
+
 
   getChangedFiles(fileTimestamps, glob) {
+    /**
+     * @param {FileSystemInfoEntry} fileSystemInfoEntry
+     * @returns {Partial<number>}
+     */
     const getTimestamps = fileSystemInfoEntry => {
-      return fileSystemInfoEntry && fileSystemInfoEntry.timestamp ? fileSystemInfoEntry.timestamp : fileSystemInfoEntry;
+      // @ts-ignore
+      if (fileSystemInfoEntry && fileSystemInfoEntry.timestamp) {
+        // @ts-ignore
+        return fileSystemInfoEntry.timestamp;
+      } // @ts-ignore
+
+
+      return fileSystemInfoEntry;
     };
+    /**
+     * @param {string} filename
+     * @param {FileSystemInfoEntry} fileSystemInfoEntry
+     * @returns {boolean}
+     */
+
 
     const hasFileChanged = (filename, fileSystemInfoEntry) => {
       const prevTimestamp = getTimestamps(this.prevTimestamps.get(filename));

package/dist/StylelintError.js

@@ -5,16 +5,29 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+/** @typedef {import('stylelint').LintResult} LintResult */
+
+/** @typedef {import('./getOptions').Options} Options */
 class StylelintError extends Error {
+  /**
+   * @param {Partial<string>} messages
+   */
   constructor(messages) {
     super(messages);
     this.name = 'StylelintError';
-    this.stack = false;
+    this.stack = '';
   }
+  /**
+   * @param {Options} options
+   * @param {Array<LintResult>} messages
+   * @returns {StylelintError}
+   */
+
 
   static format({
     formatter
   }, messages) {
+    // @ts-ignore
     return new StylelintError(formatter(messages));
   }
 

package/dist/getOptions.js

@@ -11,13 +11,34 @@ var _options = _interopRequireDefault(require("./options.json"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/** @typedef {import("stylelint")} stylelint */
+
+/**
+ * @typedef {Object} Options
+ * @property {string=} context
+ * @property {boolean=} emitError
+ * @property {boolean=} emitWarning
+ * @property {boolean=} failOnError
+ * @property {boolean=} failOnWarning
+ * @property {Array<string> | string} files
+ * @property {Function | string} formatter
+ * @property {boolean=} lintDirtyModulesOnly
+ * @property {boolean=} quiet
+ * @property {string} stylelintPath
+ */
+
+/**
+ * @param {Partial<Options>} pluginOptions
+ * @returns {Options}
+ */
 function getOptions(pluginOptions) {
   const options = {
     files: '**/*.s?(c|a)ss',
     formatter: 'string',
     stylelintPath: 'stylelint',
     ...pluginOptions
-  };
+  }; // @ts-ignore
+
   (0, _schemaUtils.default)(_options.default, options, {
     name: 'Stylelint Webpack Plugin',
     baseDataPath: 'options'
@@ -28,6 +49,12 @@ function getOptions(pluginOptions) {
   options.formatter = getFormatter(stylelint, options.formatter);
   return options;
 }
+/**
+ * @param {stylelint} stylelint
+ * @param {Function | string} formatter
+ * @returns {Function}
+ */
+
 
 function getFormatter({
   formatters
@@ -37,7 +64,9 @@ function getFormatter({
   } // Try to get oficial formatter
 
 
-  if (typeof formatter === 'string' && typeof formatters[formatter] === 'function') {
+  if (typeof formatter === 'string' && // @ts-ignore
+  typeof formatters[formatter] === 'function') {
+    // @ts-ignore
     return formatters[formatter];
   }
 

package/dist/index.js

@@ -17,10 +17,16 @@ var _utils = require("./utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/** @typedef {import('webpack').Compiler} Compiler */
 class StylelintWebpackPlugin {
   constructor(options = {}) {
     this.options = (0, _getOptions.default)(options);
   }
+  /**
+   * @param {Compiler} compiler
+   * @returns {void}
+   */
+
 
   apply(compiler) {
     const options = { ...this.options,
@@ -31,9 +37,9 @@ class StylelintWebpackPlugin {
       lint
     } = require(options.stylelintPath);
 
-    const plugin = {
-      name: this.constructor.name
-    };
+    const {
+      name: plugin
+    } = this.constructor;
 
     if (options.lintDirtyModulesOnly) {
       const lintDirty = new _LintDirtyModulesPlugin.default(lint, compiler, options);
@@ -53,14 +59,20 @@ class StylelintWebpackPlugin {
       });
     }
   }
+  /**
+   *
+   * @param {Compiler} compiler
+   * @returns {string}
+   */
+
 
   getContext(compiler) {
     if (!this.options.context) {
-      return compiler.options.context;
+      return String(compiler.options.context);
     }
 
     if (!(0, _path.isAbsolute)(this.options.context)) {
-      return (0, _path.join)(compiler.options.context, this.options.context);
+      return (0, _path.join)(String(compiler.options.context), this.options.context);
     }
 
     return this.options.context;

package/dist/linter.js

@@ -9,8 +9,38 @@ var _StylelintError = _interopRequireDefault(require("./StylelintError"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/** @typedef {import('stylelint').LinterResult} LinterResult */
+
+/** @typedef {import('stylelint').LintResult} LintResult */
+
+/** @typedef {import('webpack').Compiler} Compiler */
+
+/** @typedef {import('./getOptions').Options} Options */
+
+/**
+ * @callback Lint
+ * @param {Options} options
+ * @returns {Promise<LinterResult>}
+ */
+
+/**
+ * @callback LinterCallback
+ * @param {StylelintError | null=} error
+ * @returns {void}
+ */
+
+/**
+ * @param {Lint} lint
+ * @param {Options} options
+ * @param {Compiler} compiler
+ * @param {LinterCallback} callback
+ * @returns {void}
+ */
 function linter(lint, options, compiler, callback) {
+  /** @type {Array<LintResult>} */
   let errors = [];
+  /** @type {Array<LintResult>} */
+
   let warnings = [];
   lint(options).then(({
     results
@@ -48,9 +78,19 @@ function linter(lint, options, compiler, callback) {
     callback();
   });
 }
+/**
+ *
+ * @param {Options} options
+ * @param {Array<LintResult>} results
+ * @returns {{errors: Array<LintResult>, warnings: Array<LintResult>}}
+ */
+
 
 function parseResults(options, results) {
+  /** @type {Array<LintResult>} */
   let errors = [];
+  /** @type {Array<LintResult>} */
+
   let warnings = [];
 
   if (options.emitError) {
@@ -71,11 +111,21 @@ function parseResults(options, results) {
     warnings
   };
 }
+/**
+ * @param {LintResult} file
+ * @returns {boolean}
+ */
+
 
 function fileHasErrors(file) {
-  return file.errored;
+  return !!file.errored;
 }
+/**
+ * @param {LintResult} file
+ * @returns {boolean}
+ */
+
 
 function fileHasWarnings(file) {
-  return file.warnings && file.warnings.length;
+  return file.warnings && file.warnings.length > 0;
 }

package/dist/utils.js

@@ -10,12 +10,21 @@ var _arrify = _interopRequireDefault(require("arrify"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-// import { join } from 'path';
 const UNESCAPED_GLOB_SYMBOLS_RE = /(\\?)([()*?[\]{|}]|^!|[!+@](?=\())/g;
+/**
+ * @param {Array<string> | string} files
+ * @param {string} context
+ * @returns {Array<string>}
+ */
 
 function parseFiles(files, context) {
   return (0, _arrify.default)(files).map(file => `${replaceBackslashes(context).replace(UNESCAPED_GLOB_SYMBOLS_RE, '\\$2')}/${replaceBackslashes(file)}`);
 }
+/**
+ * @param {string} str
+ * @returns {string}
+ */
+
 
 function replaceBackslashes(str) {
   return str.replace(/\\/g, '/');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-webpack-plugin",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A Stylelint plugin for webpack",
   "license": "MIT",
   "repository": "webpack-contrib/stylelint-webpack-plugin",
@@ -15,18 +15,22 @@
     "url": "https://opencollective.com/webpack"
   },
   "main": "dist/cjs.js",
+  "types": "declarations/index.d.ts",
   "engines": {
     "node": ">= 10.13.0"
   },
   "scripts": {
     "start": "npm run build -- -w",
-    "clean": "del-cli dist",
+    "clean": "del-cli dist declarations",
     "prebuild": "npm run clean",
-    "build": "cross-env NODE_ENV=production babel src -d dist --copy-files",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir declarations && prettier \"declarations/**/*.ts\" --write",
+    "build:code": "cross-env NODE_ENV=production babel src -d dist --copy-files",
+    "build": "npm-run-all -p \"build:**\"",
     "commitlint": "commitlint --from=master",
     "security": "npm audit",
     "lint:prettier": "prettier --list-different .",
     "lint:js": "eslint --cache .",
+    "lint:types": "tsc --pretty --noEmit",
     "lint": "npm-run-all -l -p \"lint:**\"",
     "test:only": "cross-env NODE_ENV=test jest",
     "test:watch": "npm run test:only -- --watch",
@@ -38,7 +42,8 @@
     "defaults": "webpack-defaults"
   },
   "files": [
-    "dist"
+    "dist",
+    "declarations"
   ],
   "peerDependencies": {
     "stylelint": "^13.0.0",
@@ -47,33 +52,37 @@
   "dependencies": {
     "arrify": "^2.0.1",
     "micromatch": "^4.0.2",
-    "schema-utils": "^2.6.6"
+    "schema-utils": "^2.7.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.6",
-    "@babel/preset-env": "^7.9.6",
+    "@babel/cli": "^7.10.1",
+    "@babel/core": "^7.10.2",
+    "@babel/preset-env": "^7.10.2",
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
+    "@types/micromatch": "^4.0.1",
+    "@types/stylelint": "^9.10.1",
+    "@types/webpack": "^4.41.17",
     "@webpack-contrib/defaults": "^6.3.0",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^25.5.1",
+    "babel-jest": "^26.0.1",
     "cross-env": "^7.0.2",
     "del": "^5.1.0",
-    "del-cli": "^3.0.0",
-    "eslint": "^6.8.0",
+    "del-cli": "^3.0.1",
+    "eslint": "^7.2.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-friendly-formatter": "^4.0.1",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-import": "^2.21.2",
     "file-loader": "^6.0.0",
     "husky": "^4.2.5",
-    "jest": "^25.5.4",
-    "lint-staged": "^10.2.2",
+    "jest": "^26.0.1",
+    "lint-staged": "^10.2.10",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
-    "standard-version": "^7.1.0",
-    "stylelint": "^13.3.3",
+    "standard-version": "^8.0.0",
+    "stylelint": "^13.6.0",
+    "typescript": "^3.9.5",
     "webpack": "^4.43.0"
   },
   "keywords": [