@react-pug/react-pug-core 0.1.0

package/dist/language/sourceTransform.d.ts

@@ -0,0 +1,88 @@
+import type { PugDocument, PugRegion } from './mapping';
+import type { ClassAttributeName, ClassMergeMode, CompileMode } from './pugToTsx';
+import { type EncodedSourceMap } from '@jridgewell/gen-mapping';
+export type ClassAttributeOption = 'auto' | ClassAttributeName;
+export type ClassMergeOption = 'auto' | ClassMergeMode;
+export type StartupjsCssxjsOption = boolean | 'auto';
+export interface SourceTransformOptions {
+    /**
+     * Tagged template function name to match.
+     * Defaults to `pug`.
+     */
+    tagFunction?: string;
+    /**
+     * Output mode used by pug compiler.
+     * - `languageService`: TS-oriented output for editor/type-service usage.
+     * - `runtime`: JS/JSX-safe output for build tools.
+     */
+    compileMode?: CompileMode;
+    /**
+     * Which attribute receives shorthand classes.
+     * - `auto`: defaults to `className`, but may switch to `styleName` when startupjs/cssxjs is detected.
+     */
+    classAttribute?: ClassAttributeOption;
+    /**
+     * How shorthand classes merge with an existing explicit attribute value.
+     * - `concatenate`: string concatenation
+     * - `classnames`: classnames-compatible array composition
+     * - `auto`: `classnames` when target attr is `styleName`, otherwise `concatenate`
+     */
+    classMerge?: ClassMergeOption;
+    /**
+     * startupjs/cssxjs detection mode used by `auto` class strategy.
+     */
+    startupjsCssxjs?: StartupjsCssxjsOption;
+    /**
+     * When true, uppercase dot segments after a component name are treated as component path
+     * segments instead of shorthand classes.
+     *
+     * Example:
+     * - `Modal.Header.active` -> component `Modal.Header` + class `.active`
+     * - `Modal.icons.Header` -> component `Modal` + classes `.icons.Header`
+     *
+     * Defaults to true.
+     */
+    componentPathFromUppercaseClassShorthand?: boolean;
+    /**
+     * When true, require the configured tag function to be imported in files that use it.
+     * Transform-based consumers throw; the language-service path exposes a diagnostic instead.
+     */
+    requirePugImport?: boolean;
+    /**
+     * Remove the configured tag-function import from transformed/shadow output once all tag usages
+     * have been compiled away. Enabled by default.
+     */
+    removeTagImport?: boolean;
+}
+export interface SourceTransformResult {
+    /**
+     * Transformed source text where matched pug tagged templates are replaced by compiled output.
+     */
+    code: string;
+    /**
+     * Full transform document with all region metadata.
+     */
+    document: PugDocument;
+    /**
+     * Convenience alias for `document.regions`.
+     */
+    regions: PugRegion[];
+    /**
+     * Map offset in transformed code back to offset in original source.
+     * Returns null when the offset points to a synthetic unmapped span.
+     */
+    mapGeneratedOffsetToOriginal: (offset: number) => number | null;
+    /**
+     * Map offset in original source to transformed code offset.
+     * Returns null when the offset points to an unmapped span.
+     */
+    mapOriginalOffsetToGenerated: (offset: number) => number | null;
+}
+export type TransformSourceMap = EncodedSourceMap;
+export declare function transformSourceFile(sourceText: string, fileName: string, options?: SourceTransformOptions): SourceTransformResult;
+/**
+ * Build a standard VLQ source map from transformed code back to original source.
+ * This is intended to be used as an input source map for downstream compilers.
+ */
+export declare function createTransformSourceMap(transformed: Pick<SourceTransformResult, 'code' | 'document' | 'mapGeneratedOffsetToOriginal'>, fileName?: string): TransformSourceMap;
+//# sourceMappingURL=sourceTransform.d.ts.map

package/dist/language/sourceTransform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sourceTransform.d.ts","sourceRoot":"","sources":["../../src/language/sourceTransform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAElF,OAAO,EAKL,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AAIjC,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,kBAAkB,CAAC;AAC/D,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,cAAc,CAAC;AACvD,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,MAAM,CAAC;AAErD,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAC;IAExC;;;;;;;;;OASG;IACH,wCAAwC,CAAC,EAAE,OAAO,CAAC;IAEnD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,SAAS,EAAE,CAAC;IAErB;;;OAGG;IACH,4BAA4B,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,4BAA4B,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;CACjE;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAElD,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,sBAA2B,GACnC,qBAAqB,CA8CvB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,MAAM,GAAG,UAAU,GAAG,8BAA8B,CAAC,EAC9F,QAAQ,GAAE,MAAiC,GAC1C,kBAAkB,CA4CpB"}

package/dist/language/sourceTransform.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformSourceFile = transformSourceFile;
+exports.createTransformSourceMap = createTransformSourceMap;
+const shadowDocument_1 = require("./shadowDocument");
+const positionMapping_1 = require("./positionMapping");
+const diagnosticMapping_1 = require("./diagnosticMapping");
+const gen_mapping_1 = require("@jridgewell/gen-mapping");
+const STARTUPJS_OR_CSSXJS_RE = /['"](?:startupjs|cssxjs)['"]/;
+function transformSourceFile(sourceText, fileName, options = {}) {
+    const tagFunction = options.tagFunction ?? 'pug';
+    const startupjsCssxjs = options.startupjsCssxjs === true
+        || (options.startupjsCssxjs !== false && STARTUPJS_OR_CSSXJS_RE.test(sourceText));
+    const classAttribute = (options.classAttribute === 'className'
+        || options.classAttribute === 'class'
+        || options.classAttribute === 'styleName') ? options.classAttribute : (startupjsCssxjs ? 'styleName' : 'className');
+    const classMerge = (options.classMerge === 'concatenate'
+        || options.classMerge === 'classnames') ? options.classMerge : (classAttribute === 'styleName' ? 'classnames' : 'concatenate');
+    const document = (0, shadowDocument_1.buildShadowDocument)(sourceText, fileName, 1, tagFunction, {
+        mode: options.compileMode ?? 'languageService',
+        classAttribute,
+        classMerge,
+        componentPathFromUppercaseClassShorthand: options.componentPathFromUppercaseClassShorthand ?? true,
+        requirePugImport: options.requirePugImport ?? false,
+        removeTagImport: options.removeTagImport ?? true,
+    });
+    if (options.requirePugImport && document.usesTagFunction && !document.hasTagImport) {
+        throw new Error(`Missing import for tag function "${tagFunction}" in ${fileName}`);
+    }
+    const transformErrorRegion = document.regions.find(region => region.transformError != null);
+    if (transformErrorRegion?.transformError) {
+        const error = transformErrorRegion.transformError;
+        throw new Error(`${error.message} in ${fileName}:${error.line}:${error.column}`);
+    }
+    return {
+        code: document.shadowText,
+        document,
+        regions: document.regions,
+        mapGeneratedOffsetToOriginal: (offset) => (0, positionMapping_1.shadowToOriginal)(document, offset),
+        mapOriginalOffsetToGenerated: (offset) => (0, positionMapping_1.originalToShadow)(document, offset),
+    };
+}
+/**
+ * Build a standard VLQ source map from transformed code back to original source.
+ * This is intended to be used as an input source map for downstream compilers.
+ */
+function createTransformSourceMap(transformed, fileName = transformed.document.uri) {
+    const sourceName = fileName;
+    const map = new gen_mapping_1.GenMapping({ file: fileName });
+    (0, gen_mapping_1.setSourceContent)(map, sourceName, transformed.document.originalText);
+    let generatedLine = 0;
+    let generatedColumn = 0;
+    let lastMappedOriginalOffset = null;
+    for (let i = 0; i < transformed.code.length; i += 1) {
+        const mappedOriginalOffset = transformed.mapGeneratedOffsetToOriginal(i);
+        if (mappedOriginalOffset != null) {
+            const shouldEmitSegment = (generatedColumn === 0
+                || lastMappedOriginalOffset == null
+                || mappedOriginalOffset !== lastMappedOriginalOffset + 1);
+            if (shouldEmitSegment) {
+                const original = (0, diagnosticMapping_1.offsetToLineColumn)(transformed.document.originalText, mappedOriginalOffset);
+                (0, gen_mapping_1.addSegment)(map, generatedLine, generatedColumn, sourceName, Math.max(0, original.line - 1), Math.max(0, original.column - 1));
+            }
+            lastMappedOriginalOffset = mappedOriginalOffset;
+        }
+        else {
+            lastMappedOriginalOffset = null;
+        }
+        if (transformed.code.charCodeAt(i) === 10) {
+            generatedLine += 1;
+            generatedColumn = 0;
+            lastMappedOriginalOffset = null;
+        }
+        else {
+            generatedColumn += 1;
+        }
+    }
+    return (0, gen_mapping_1.toEncodedMap)(map);
+}
+//# sourceMappingURL=sourceTransform.js.map

package/dist/language/sourceTransform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sourceTransform.js","sourceRoot":"","sources":["../../src/language/sourceTransform.ts"],"names":[],"mappings":";;AA4GA,kDAkDC;AAMD,4DA+CC;AAlND,qDAAuD;AACvD,uDAAuE;AAEvE,2DAAyD;AACzD,yDAMiC;AAEjC,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AA+F9D,SAAgB,mBAAmB,CACjC,UAAkB,EAClB,QAAgB,EAChB,UAAkC,EAAE;IAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC;IACjD,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,KAAK,IAAI;WACnD,CAAC,OAAO,CAAC,eAAe,KAAK,KAAK,IAAI,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpF,MAAM,cAAc,GAAuB,CACzC,OAAO,CAAC,cAAc,KAAK,WAAW;WACnC,OAAO,CAAC,cAAc,KAAK,OAAO;WAClC,OAAO,CAAC,cAAc,KAAK,WAAW,CAC1C,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAmB,CACjC,OAAO,CAAC,UAAU,KAAK,aAAa;WACjC,OAAO,CAAC,UAAU,KAAK,YAAY,CACvC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IAEzF,MAAM,QAAQ,GAAG,IAAA,oCAAmB,EAClC,UAAU,EACV,QAAQ,EACR,CAAC,EACD,WAAW,EACX;QACE,IAAI,EAAE,OAAO,CAAC,WAAW,IAAI,iBAAiB;QAC9C,cAAc;QACd,UAAU;QACV,wCAAwC,EAAE,OAAO,CAAC,wCAAwC,IAAI,IAAI;QAClG,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,KAAK;QACnD,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;KACjD,CACF,CAAC;IAEF,IAAI,OAAO,CAAC,gBAAgB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;QACnF,MAAM,IAAI,KAAK,CAAC,oCAAoC,WAAW,QAAQ,QAAQ,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,MAAM,oBAAoB,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC;IAC5F,IAAI,oBAAoB,EAAE,cAAc,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,oBAAoB,CAAC,cAAc,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC,OAAO,OAAO,QAAQ,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,UAAU;QACzB,QAAQ;QACR,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,4BAA4B,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,IAAA,kCAAgB,EAAC,QAAQ,EAAE,MAAM,CAAC;QACpF,4BAA4B,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,IAAA,kCAAgB,EAAC,QAAQ,EAAE,MAAM,CAAC;KACrF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CACtC,WAA8F,EAC9F,WAAmB,WAAW,CAAC,QAAQ,CAAC,GAAG;IAE3C,MAAM,UAAU,GAAG,QAAQ,CAAC;IAC5B,MAAM,GAAG,GAAG,IAAI,wBAAU,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,IAAA,8BAAgB,EAAC,GAAG,EAAE,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAErE,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,wBAAwB,GAAkB,IAAI,CAAC;IAEnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,oBAAoB,GAAG,WAAW,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACzE,IAAI,oBAAoB,IAAI,IAAI,EAAE,CAAC;YACjC,MAAM,iBAAiB,GAAG,CACxB,eAAe,KAAK,CAAC;mBAClB,wBAAwB,IAAI,IAAI;mBAChC,oBAAoB,KAAK,wBAAwB,GAAG,CAAC,CACzD,CAAC;YAEF,IAAI,iBAAiB,EAAE,CAAC;gBACtB,MAAM,QAAQ,GAAG,IAAA,sCAAkB,EAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;gBAC7F,IAAA,wBAAU,EACR,GAAG,EACH,aAAa,EACb,eAAe,EACf,UAAU,EACV,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC,EAC9B,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CACjC,CAAC;YACJ,CAAC;YACD,wBAAwB,GAAG,oBAAoB,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,wBAAwB,GAAG,IAAI,CAAC;QAClC,CAAC;QAED,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YAC1C,aAAa,IAAI,CAAC,CAAC;YACnB,eAAe,GAAG,CAAC,CAAC;YACpB,wBAAwB,GAAG,IAAI,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,eAAe,IAAI,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,IAAA,0BAAY,EAAC,GAAG,CAAC,CAAC;AAC3B,CAAC"}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@react-pug/react-pug-core",
+  "main": "./dist/index.js",
+  "version": "0.1.0",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@babel/parser": "^7.0.0",
+    "@jridgewell/gen-mapping": "^0.3.13",
+    "@startupjs/pug-lexer": "^4.1.0-1",
+    "@volar/source-map": "^2.4.28",
+    "pug-parser": "^6.0.0",
+    "pug-strip-comments": "^2.0.0"
+  },
+  "gitHead": "b4e9f09659dd4c70d0734759ea00710414fd8366"
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "dist"
+  ]
+}