@jesscss/core 2.0.0-alpha.1

package/lib/tree/import-style.d.ts

@@ -0,0 +1,156 @@
+import { Node } from './node.js';
+import { type Reference } from './reference.js';
+import { Rules, type RulesOptions } from './rules.js';
+import { type Quoted } from './quoted.js';
+import { Url } from './url.js';
+import { type Context } from '../context.js';
+import { type MaybePromise } from '@jesscss/awaitable-pipe';
+import type { Collection } from './collection.js';
+/**
+ * This class is for Jess / Sass+ / Less-style imports,
+ * not the CSS `@import` rule. The two will be distinguished
+ * during parsing.
+ *
+ * @see https://sass-lang.com/documentation/at-rules/import/#plain-css-imports
+ */
+export type ImportOptions = {
+    /**
+     * Affects evaluation - will be passed to registered import handlers when parsing.
+     * Normally this is done by file extension, but can be overridden to select a
+     * particular plugin handler.
+     *
+     * e.g. `@-import (type: less) 'foo.css';`
+     */
+    type?: string;
+    /** Rules are not rendered in output. */
+    reference?: boolean;
+    optional?: boolean;
+    inline?: boolean;
+    /**
+     * Optional import postlude captured by parsers for forms like:
+     * `@import (inline) "x.css" layer(foo) supports(display: grid) screen;`
+     *
+     * For inline imports, this is applied as serializer wrappers around the inlined source.
+     */
+    postlude?: Node;
+    /**
+     * Less's default behavior for `@import` is to only output any resolved resource once.
+     * In Jess, subsequent imports should output as reference unless the `multiple` option
+     * is set to true.
+     *
+     * @todo - Investigate what Sass does.
+     */
+    multiple?: boolean;
+    /**
+     * Allow extends to reach into this import.
+     * Default is false for @-compose (protected by default), true for @-import.
+     */
+    mutable?: boolean;
+    /**
+     * Sass `@forward` semantics:
+     * - members are NOT visible to the current stylesheet scope
+     * - members ARE made available downstream when this stylesheet is imported
+     */
+    forward?: boolean;
+    /**
+     * Sass `@forward ... as <prefix>-*;` prefixing.
+     * Stores the prefix portion (e.g. `bar-` from `bar-*`).
+     */
+    forwardAsPrefix?: string;
+    /**
+     * Sass `@forward ... show ...;` list.
+     * We capture raw member names (e.g. `$a`, `mixin-b`, `fn-c`) without semantics yet.
+     */
+    forwardShow?: string[];
+    /**
+     * Sass `@forward ... hide ...;` list.
+     * We capture raw member names (e.g. `$a`, `mixin-b`, `fn-c`) without semantics yet.
+     */
+    forwardHide?: string[];
+    /** Variables can't be reassigned (default is true for `@-compose` and false for `@-import`). */
+    readonly?: boolean;
+    /** Internal marker for "once" de-duplication rendering semantics. */
+    _dedupe?: boolean;
+    [key: string]: unknown;
+};
+export type StyleImportOptions = {
+    /**
+     * Old-style `@import` type or new `@-compose` type.
+     */
+    type: 'import' | 'compose';
+    /**
+     * Options passed to the Jess import plugin. Options are interpreted like
+     * querystring parameters i.e.
+     *   e.g. `@-import (foo, bar, baz: 1) 'foo.css';`
+     *     - foo: true
+     *     - bar: true
+     *     - baz: '1'
+     */
+    importOptions?: ImportOptions;
+    /** e.g. `import * as foo` sets namespace to `foo` */
+    namespace?: string;
+    /** Set on the import node instead of on rules */
+    local?: boolean;
+    rulesVisibility?: RulesOptions['rulesVisibility'];
+};
+export type StyleImportValue = {
+    path: Quoted | Url;
+    /** Values to inject */
+    with?: {
+        node: Reference | Collection;
+        /**
+         * For use / ref / include statements, will affect how this module is evaluated
+         * every time. 'set' can be used once per module, 'with' can be used multiple.
+         * In Sass, 'set' is called 'with' and 'with' will be parsed as 'set'.
+         *   e.g.
+         *     `@-use 'library' set { $foo: 1 };` -- $foo will be set to 1 every time
+         *     `@-use 'library' with { $foo: 1 };` -- $foo will be set to 1 just for this scope.
+         */
+        type: 'with' | 'set';
+    };
+};
+export interface StyleImport extends Node<StyleImportValue, StyleImportOptions> {
+    eval(context: Context): MaybePromise<Rules>;
+}
+/**
+ * This is a generic class for:
+ *   - Sass+ `@use` (for stylesheets)
+ *   - Jess `@-compose` and Less `@compose`
+ *   - Less, Sass+, and Jess `@import` / `@-import` that are indicated
+ *     to be processed by the engine
+ *
+ * @see https://sass-lang.com/documentation/at-rules/import/
+ */
+export declare class StyleImport extends Node<StyleImportValue, StyleImportOptions> {
+    type: "StyleImport";
+    shortType: "style";
+    constructor(value: StyleImportValue, options?: StyleImportOptions, location?: any, treeContext?: any);
+    getFinalRules(evaluatedRules: Rules): Rules;
+    /**
+     * Defer import-path interpolation to evalNode so unresolved vars can be retried
+     * after later imports/assignments in the same Rules scope have evaluated.
+     */
+    preEval(_context: Context): MaybePromise<this>;
+    /**
+     * @note
+     * When imports are evaluated, they should be deeply cloned. The reason is that
+     * they can be used in multiple places, and can be evaluated differently
+     * each time, so they are more like a function call.
+     *
+     * @todo
+     * How do extends work then?
+     */
+    evalNode(context: Context): MaybePromise<Rules>;
+    /**
+     * Applies CSS import postlude wrappers around inline source content.
+     * Falls back to `@media <postlude>` for plain query nodes.
+     */
+    private wrapInlineSourceWithPostlude;
+    /**
+     * Applies CSS import postlude wrappers around evaluated stylesheet rules.
+     * Used for Less-style imports with media/layer/supports postludes.
+     */
+    private wrapEvaluatedRulesWithPostlude;
+}
+export declare const style: (...args: ConstructorParameters<typeof StyleImport>) => StyleImport;
+//# sourceMappingURL=import-style.d.ts.map

package/lib/tree/import-style.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-style.d.ts","sourceRoot":"","sources":["../../src/tree/import-style.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoD,MAAM,WAAW,CAAC;AACnF,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,KAAK,YAAY,EAAwB,MAAM,YAAY,CAAC;AAC5E,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,KAAK,YAAY,EAAc,MAAM,yBAAyB,CAAC;AAGxE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAIlD;;;;;;GAMG;AAEH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,gGAAgG;IAChG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE3B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB,uBAAuB;IACvB,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,SAAS,GAAG,UAAU,CAAC;QAC7B;;;;;;;WAOG;QACH,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC;IAC7E,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;CAC7C;AACD;;;;;;;;GAQG;AACH,qBAAa,WAAY,SAAQ,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC;IACzE,IAAI,EAAG,aAAa,CAAU;IAC9B,SAAS,EAAG,OAAO,CAAU;gBAEjB,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG;IAMpG,aAAa,CAAC,cAAc,EAAE,KAAK;IA6FnC;;;OAGG;IACM,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC;IAIvD;;;;;;;;OAQG;IACM,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC;IAiXxD;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAsCpC;;;OAGG;IACH,OAAO,CAAC,8BAA8B;CAmCvC;AAID,eAAO,MAAM,KAAK,GAAI,GAAG,MAAM,qBAAqB,CAAC,OAAO,WAAW,CAAC,gBAEvE,CAAC"}