@react-pug/eslint-plugin-react-pug 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# @react-pug/eslint-plugin-react-pug
+
+ESLint processor for linting files that contain `pug\`...\`` tagged template literals.
+
+## Install
+
+```bash
+npm i -D @react-pug/eslint-plugin-react-pug eslint
+```
+
+## Usage
+
+```js
+import reactPugPlugin from '@react-pug/eslint-plugin-react-pug'
+
+export default [
+  {
+    files: ['**/*.{js,jsx,ts,tsx}'],
+    plugins: { 'react-pug': reactPugPlugin },
+    processor: 'react-pug/pug-react'
+  }
+]
+```
+
+## Options
+
+Use `createReactPugProcessor(...)` when you need custom options:
+
+- `tagFunction`
+- `requirePugImport`
+- `classShorthandProperty`
+- `classShorthandMerge`
+- `startupjsCssxjs`
+- `componentPathFromUppercaseClassShorthand`
+
+Used `pug` import bindings are removed from the processor's transformed view automatically.
+
+## Exports
+
+- default ESLint plugin object
+- `createReactPugProcessor(...)`
+
+Published output is in `dist/`.

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import { type ClassAttributeOption, type ClassMergeOption, type StartupjsCssxjsOption } from '@react-pug/react-pug-core';
+export interface EslintReactPugProcessorOptions {
+    tagFunction?: string;
+    requirePugImport?: boolean;
+    classShorthandProperty?: ClassAttributeOption;
+    classShorthandMerge?: ClassMergeOption;
+    startupjsCssxjs?: StartupjsCssxjsOption;
+    componentPathFromUppercaseClassShorthand?: boolean;
+}
+interface EslintLintMessage {
+    line?: number;
+    column?: number;
+    endLine?: number;
+    endColumn?: number;
+    [key: string]: unknown;
+}
+export interface EslintProcessorLike {
+    preprocess: (text: string, filename: string) => string[];
+    postprocess: (messages: EslintLintMessage[][], filename: string) => EslintLintMessage[];
+    supportsAutofix: boolean;
+}
+export declare function createReactPugProcessor(options?: EslintReactPugProcessorOptions): EslintProcessorLike;
+declare const plugin: {
+    processors: {
+        'pug-react': EslintProcessorLike;
+    };
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EAIrB,KAAK,qBAAqB,EAE3B,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,8BAA8B;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sBAAsB,CAAC,EAAE,oBAAoB,CAAC;IAC9C,mBAAmB,CAAC,EAAE,gBAAgB,CAAC;IACvC,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,wCAAwC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,UAAU,iBAAiB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAID,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;IACzD,WAAW,EAAE,CAAC,QAAQ,EAAE,iBAAiB,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,KAAK,iBAAiB,EAAE,CAAC;IACxF,eAAe,EAAE,OAAO,CAAC;CAC1B;AAiCD,wBAAgB,uBAAuB,CACrC,OAAO,GAAE,8BAAmC,GAC3C,mBAAmB,CA+BrB;AAID,QAAA,MAAM,MAAM;;;;CAIX,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReactPugProcessor = createReactPugProcessor;
+const react_pug_core_1 = require("@react-pug/react-pug-core");
+function mapLintMessage(message, transformed) {
+    if (message.line == null || message.column == null)
+        return message;
+    const generatedStart = (0, react_pug_core_1.lineColumnToOffset)(transformed.code, message.line, message.column);
+    const generatedEnd = (message.endLine != null && message.endColumn != null)
+        ? (0, react_pug_core_1.lineColumnToOffset)(transformed.code, message.endLine, message.endColumn)
+        : generatedStart + 1;
+    const mapped = (0, react_pug_core_1.mapGeneratedRangeToOriginal)(transformed.document, generatedStart, Math.max(1, generatedEnd - generatedStart));
+    if (!mapped)
+        return message;
+    const startLc = (0, react_pug_core_1.offsetToLineColumn)(transformed.document.originalText, mapped.start);
+    const endLc = (0, react_pug_core_1.offsetToLineColumn)(transformed.document.originalText, mapped.end);
+    return {
+        ...message,
+        line: startLc.line,
+        column: startLc.column,
+        endLine: endLc.line,
+        endColumn: endLc.column,
+    };
+}
+function createReactPugProcessor(options = {}) {
+    const cache = new Map();
+    return {
+        preprocess(text, filename) {
+            const transformed = (0, react_pug_core_1.transformSourceFile)(text, filename, {
+                tagFunction: options.tagFunction ?? 'pug',
+                compileMode: 'runtime',
+                requirePugImport: options.requirePugImport ?? false,
+                classAttribute: options.classShorthandProperty ?? 'auto',
+                classMerge: options.classShorthandMerge ?? 'auto',
+                startupjsCssxjs: options.startupjsCssxjs ?? 'auto',
+                componentPathFromUppercaseClassShorthand: options.componentPathFromUppercaseClassShorthand ?? true,
+            });
+            cache.set(filename, transformed);
+            return [transformed.code];
+        },
+        postprocess(messages, filename) {
+            const transformed = cache.get(filename);
+            cache.delete(filename);
+            const flat = messages.flat();
+            if (!transformed)
+                return flat;
+            if (transformed.regions.length === 0)
+                return flat;
+            return flat.map((msg) => mapLintMessage(msg, transformed));
+        },
+        supportsAutofix: true,
+    };
+}
+const defaultProcessor = createReactPugProcessor();
+const plugin = {
+    processors: {
+        'pug-react': defaultProcessor,
+    },
+};
+exports.default = plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAkEA,0DAiCC;AAnGD,8DAQmC;AA2BnC,SAAS,cAAc,CACrB,OAA0B,EAC1B,WAAiC;IAEjC,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,OAAO,CAAC;IAEnE,MAAM,cAAc,GAAG,IAAA,mCAAkB,EAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1F,MAAM,YAAY,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC;QACzE,CAAC,CAAC,IAAA,mCAAkB,EAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC;QAC1E,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC;IAEvB,MAAM,MAAM,GAAG,IAAA,4CAA2B,EACxC,WAAW,CAAC,QAAQ,EACpB,cAAc,EACd,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,CAC3C,CAAC;IAEF,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC;IAE5B,MAAM,OAAO,GAAG,IAAA,mCAAkB,EAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACpF,MAAM,KAAK,GAAG,IAAA,mCAAkB,EAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAEhF,OAAO;QACL,GAAG,OAAO;QACV,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,SAAS,EAAE,KAAK,CAAC,MAAM;KACxB,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,UAA0C,EAAE;IAE5C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAgC,CAAC;IAEtD,OAAO;QACL,UAAU,CAAC,IAAY,EAAE,QAAgB;YACvC,MAAM,WAAW,GAAG,IAAA,oCAAmB,EAAC,IAAI,EAAE,QAAQ,EAAE;gBACtD,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK;gBACzC,WAAW,EAAE,SAAS;gBACtB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,KAAK;gBACnD,cAAc,EAAE,OAAO,CAAC,sBAAsB,IAAI,MAAM;gBACxD,UAAU,EAAE,OAAO,CAAC,mBAAmB,IAAI,MAAM;gBACjD,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,MAAM;gBAClD,wCAAwC,EAAE,OAAO,CAAC,wCAAwC,IAAI,IAAI;aACnG,CAAC,CAAC;YACH,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACjC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED,WAAW,CAAC,QAA+B,EAAE,QAAgB;YAC3D,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEvB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,WAAW;gBAAE,OAAO,IAAI,CAAC;YAC9B,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAElD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC;QAC7D,CAAC;QAED,eAAe,EAAE,IAAI;KACtB,CAAC;AACJ,CAAC;AAED,MAAM,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;AAEnD,MAAM,MAAM,GAAG;IACb,UAAU,EAAE;QACV,WAAW,EAAE,gBAAgB;KAC9B;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@react-pug/eslint-plugin-react-pug",
+  "version": "0.1.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npm --prefix ../.. run build -w @react-pug/react-pug-core && rm -rf dist && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@react-pug/react-pug-core": "^0.1.0"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0"
+  },
+  "gitHead": "b4e9f09659dd4c70d0734759ea00710414fd8366"
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": {
+      "@react-pug/react-pug-core": [
+        "../react-pug-core/src/index.ts"
+      ]
+    }
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "dist"
+  ]
+}