feat: removed cjs wrapper (#265)

* feat: removed cjs wrapper

* fix: exports

* docs: formatting

* ci: update

.github/workflows/nodejs.yml

@@ -52,7 +52,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [12.x, 14.x, 16.x, 17.x]
+        node-version: [12.x, 14.x, 16.x]
         stylelint-version: [13.x, 14.x]
         webpack-version: [latest]
 

README.md

@@ -274,9 +274,7 @@ type outputReport =
       formatter?:
         | (
             | string
-            | ((
-                results: Array<import('stylelint').LintResult>
-              ) => string)
+            | ((results: Array<import('stylelint').LintResult>) => string)
           )
         | undefined;
     };

package.json

@@ -11,16 +11,16 @@
     "type": "opencollective",
     "url": "https://opencollective.com/webpack"
   },
-  "main": "dist/cjs.js",
-  "types": "declarations/index.d.ts",
+  "main": "dist/index.js",
+  "types": "types/index.d.ts",
   "engines": {
     "node": ">= 12.13.0"
   },
   "scripts": {
     "start": "npm run build -- -w",
-    "clean": "del-cli dist declarations",
+    "clean": "del-cli dist types",
     "prebuild": "npm run clean",
-    "build:types": "tsc --declaration --emitDeclarationOnly --outDir declarations && prettier \"declarations/**/*.ts\" --write",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir types && prettier \"types/**/*.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",
@@ -39,7 +39,7 @@
   },
   "files": [
     "dist",
-    "declarations"
+    "types"
   ],
   "peerDependencies": {
     "stylelint": "^13.0.0 || ^14.0.0",

src/StylelintError.js

@@ -9,4 +9,4 @@ class StylelintError extends Error {
   }
 }
 
-export default StylelintError;
+module.exports = StylelintError;

src/getStylelint.js

@@ -1,11 +1,11 @@
-import { cpus } from 'os';
+const { cpus } = require('os');
 
-import { Worker as JestWorker } from 'jest-worker';
+const { Worker: JestWorker } = require('jest-worker');
 
 // @ts-ignore
-import { setup, lintFiles } from './worker';
-import { jsonStringifyReplacerSortKeys } from './utils';
-import { getStylelintOptions } from './options';
+const { setup, lintFiles } = require('./worker');
+const { jsonStringifyReplacerSortKeys } = require('./utils');
+const { getStylelintOptions } = require('./options');
 
 /** @type {{[key: string]: any}} */
 const cache = {};
@@ -80,7 +80,7 @@ function loadStylelintThreaded(key, poolSize, options) {
  * @param {Options} options
  * @returns {Linter}
  */
-export default function getStylelint(key, { threads, ...options }) {
+function getStylelint(key, { threads, ...options }) {
   const max =
     typeof threads !== 'number' ? (threads ? cpus().length - 1 : 1) : threads;
 
@@ -102,3 +102,5 @@ export default function getStylelint(key, { threads, ...options }) {
 function getCacheKey(key, options) {
   return JSON.stringify({ key, options }, jsonStringifyReplacerSortKeys);
 }
+
+module.exports = getStylelint;

src/index.js

@@ -1,13 +1,11 @@
-import { isAbsolute, join } from 'path';
+const { isAbsolute, join } = require('path');
 
-// @ts-ignore
-import globby from 'globby';
+const globby = require('globby');
+const { isMatch } = require('micromatch');
 
-import { isMatch } from 'micromatch';
-
-import { getOptions } from './options';
-import linter from './linter';
-import { arrify, parseFiles, parseFoldersToGlobs } from './utils';
+const { getOptions } = require('./options');
+const linter = require('./linter');
+const { arrify, parseFiles, parseFoldersToGlobs } = require('./utils');
 
 /** @typedef {import('webpack').Compiler} Compiler */
 /** @typedef {import('webpack').Module} Module */
@@ -110,6 +108,8 @@ class StylelintWebpackPlugin {
       }
 
       compilation.hooks.finishModules.tapPromise(this.key, async () => {
+        /** @type {string[]} */
+        // @ts-ignore
         const files = (
           await Promise.all(
             (compiler.modifiedFiles
@@ -119,7 +119,7 @@ class StylelintWebpackPlugin {
                     !isMatch(file, exclude, { dot: true })
                 )
               : globby.sync(wanted, { dot: true, ignore: exclude })
-            ).map(async (/** @type {string | undefined} */ file) => {
+            ).map(async (file) => {
               try {
                 return (await api.isPathIgnored(file)) ? false : file;
               } catch (e) {
@@ -185,4 +185,4 @@ class StylelintWebpackPlugin {
   }
 }
 
-export default StylelintWebpackPlugin;
+module.exports = StylelintWebpackPlugin;

src/linter.js

@@ -1,8 +1,8 @@
-import { dirname, isAbsolute, join } from 'path';
+const { dirname, isAbsolute, join } = require('path');
 
-import StylelintError from './StylelintError';
-import getStylelint from './getStylelint';
-import { arrify } from './utils';
+const StylelintError = require('./StylelintError');
+const getStylelint = require('./getStylelint');
+const { arrify } = require('./utils');
 
 /** @typedef {import('stylelint')} Stylelint */
 /** @typedef {import('stylelint').LintResult} LintResult */
@@ -27,7 +27,7 @@ const resultStorage = new WeakMap();
  * @param {Compilation} compilation
  * @returns {{api: InternalApi, lint: Linter, report: Reporter, threads: number}}
  */
-export default function linter(key, options, compilation) {
+function linter(key, options, compilation) {
   /** @type {Stylelint} */
   let stylelint;
 
@@ -275,3 +275,5 @@ function getResultStorage({ compiler }) {
   }
   return storage;
 }
+
+module.exports = linter;

src/options.js

@@ -1,7 +1,6 @@
-import { validate } from 'schema-utils';
+const { validate } = require('schema-utils');
 
-// @ts-ignore
-import schema from './options.json';
+const schema = require('./options.json');
 
 /** @typedef {import("stylelint")} stylelint */
 /** @typedef {import("stylelint").LinterOptions} StylelintOptions */
@@ -37,7 +36,7 @@ import schema from './options.json';
  * @param {Options} pluginOptions
  * @returns {Partial<PluginOptions>}
  */
-export function getOptions(pluginOptions) {
+function getOptions(pluginOptions) {
   const options = {
     extensions: ['css', 'scss', 'sass'],
     emitError: true,
@@ -60,7 +59,7 @@ export function getOptions(pluginOptions) {
  * @param {Options} pluginOptions
  * @returns {Partial<StylelintOptions>}
  */
-export function getStylelintOptions(pluginOptions) {
+function getStylelintOptions(pluginOptions) {
   const stylelintOptions = { ...pluginOptions };
 
   // Keep the files and formatter option because it is common to both the plugin and Stylelint.
@@ -75,3 +74,8 @@ export function getStylelintOptions(pluginOptions) {
 
   return stylelintOptions;
 }
+
+module.exports = {
+  getOptions,
+  getStylelintOptions,
+};

src/utils.js

@@ -1,8 +1,7 @@
-import { resolve } from 'path';
-import { statSync } from 'fs';
+const { resolve } = require('path');
+const { statSync } = require('fs');
 
-// @ts-ignore
-import normalizePath from 'normalize-path';
+const normalizePath = require('normalize-path');
 
 /**
  * @template T
@@ -20,7 +19,7 @@ import normalizePath from 'normalize-path';
  }
  */
 /* istanbul ignore next */
-export function arrify(value) {
+function arrify(value) {
   // eslint-disable-next-line no-undefined
   if (value === null || value === undefined) {
     // @ts-ignore
@@ -52,7 +51,7 @@ export function arrify(value) {
  * @param {string} context
  * @returns {string[]}
  */
-export function parseFiles(files, context) {
+function parseFiles(files, context) {
   return arrify(files).map((/** @type {string} */ file) =>
     normalizePath(resolve(context, file))
   );
@@ -63,7 +62,7 @@ export function parseFiles(files, context) {
  * @param {string|string[]} extensions
  * @returns {string[]}
  */
-export function parseFoldersToGlobs(patterns, extensions = []) {
+function parseFoldersToGlobs(patterns, extensions = []) {
   const extensionsList = arrify(extensions);
   const [prefix, postfix] = extensionsList.length > 1 ? ['{', '}'] : ['', ''];
   const extensionsGlob = extensionsList
@@ -95,7 +94,7 @@ export function parseFoldersToGlobs(patterns, extensions = []) {
  * @param {string} _ key, but unused
  * @param {any} value
  */
-export const jsonStringifyReplacerSortKeys = (_, value) => {
+const jsonStringifyReplacerSortKeys = (_, value) => {
   /**
    * @param {{ [x: string]: any; }} sorted
    * @param {string | number} key
@@ -110,3 +109,10 @@ export const jsonStringifyReplacerSortKeys = (_, value) => {
     ? Object.keys(value).sort().reduce(insert, {})
     : value;
 };
+
+module.exports = {
+  arrify,
+  parseFiles,
+  parseFoldersToGlobs,
+  jsonStringifyReplacerSortKeys,
+};

declarations/StylelintError.d.ts → types/StylelintError.d.ts

@@ -1,4 +1,4 @@
-export default StylelintError;
+export = StylelintError;
 declare class StylelintError extends Error {
   /**
    * @param {string=} messages

declarations/getStylelint.d.ts → types/getStylelint.d.ts

@@ -1,14 +1,34 @@
 /// <reference types="stylelint" />
+export = getStylelint;
 /**
  * @param {string|undefined} key
  * @param {Options} options
  * @returns {Linter}
  */
-export default function getStylelint(
+declare function getStylelint(
   key: string | undefined,
   { threads, ...options }: Options
 ): Linter;
-export type Stylelint = import('postcss').PluginCreator<
+declare namespace getStylelint {
+  export {
+    Stylelint,
+    LintResult,
+    Options,
+    AsyncTask,
+    LintTask,
+    Linter,
+    Worker,
+  };
+}
+type Options = import('./options').Options;
+type Linter = {
+  api: import('stylelint').InternalApi;
+  stylelint: Stylelint;
+  lintFiles: LintTask;
+  cleanup: AsyncTask;
+  threads: number;
+};
+type Stylelint = import('postcss').PluginCreator<
   import('stylelint').PostcssPluginOptions
 > & {
   lint: (
@@ -63,16 +83,9 @@ export type Stylelint = import('postcss').PluginCreator<
     ) => void;
   };
 };
-export type LintResult = import('stylelint').LintResult;
-export type Options = import('./options').Options;
-export type AsyncTask = () => Promise<void>;
-export type LintTask = (files: string | string[]) => Promise<LintResult[]>;
-export type Linter = {
-  stylelint: Stylelint;
-  lintFiles: LintTask;
-  cleanup: AsyncTask;
-  threads: number;
-};
-export type Worker = import('jest-worker').Worker & {
+type LintResult = import('stylelint').LintResult;
+type AsyncTask = () => Promise<void>;
+type LintTask = (files: string | string[]) => Promise<LintResult[]>;
+type Worker = import('jest-worker').Worker & {
   lintFiles: LintTask;
 };

declarations/index.d.ts → types/index.d.ts

@@ -1,13 +1,4 @@
-export default StylelintWebpackPlugin;
-export type Compiler = import('webpack').Compiler;
-export type Module = import('webpack').Module;
-export type Options = import('./options').Options;
-export type FileSystemInfoEntry = Partial<
-  | {
-      timestamp: number;
-    }
-  | number
->;
+export = StylelintWebpackPlugin;
 declare class StylelintWebpackPlugin {
   /**
    * @param {Options} options
@@ -33,3 +24,15 @@ declare class StylelintWebpackPlugin {
    */
   getContext(compiler: Compiler): string;
 }
+declare namespace StylelintWebpackPlugin {
+  export { Compiler, Module, Options, FileSystemInfoEntry };
+}
+type Compiler = import('webpack').Compiler;
+type Options = import('./options').Options;
+type Module = import('webpack').Module;
+type FileSystemInfoEntry = Partial<
+  | {
+      timestamp: number;
+    }
+  | number
+>;