@figma/code-connect 0.1.1 → 0.2.0

package/dist/common/project.d.ts

@@ -1,84 +0,0 @@
-import ts from 'typescript';
-export interface CodeConnectConfig {
-    /**
-     * Specify glob patterns for files (relative to the project root) to be
-     * included when looking for source files. If not specified, all files
-     * (except any specified in `exclude`) will be included.
-     */
-    include?: string[];
-    /**
-     * Specify glob patterns for files (relative to the project root) to be
-     * excluded when looking for source files. If not specified, only
-     * `node_modules` will be excluded.
-     */
-    exclude?: string[];
-    /**
-     * Optional object of substitutions applied to document URLs (in the format {
-     * fromString, toString }) for testing (e.g. remapping a production URL to a
-     * staging URL). Not publicly documented.
-     */
-    documentUrlSubstitutions?: Record<string, string>;
-    /**
-     * React specific configuration
-     */
-    react?: {
-        /**
-         * Maps imports from their path on disk to the specified path.
-         * This will rewrite the imports in generated code examples, so it works with
-         * relative imports such as `import { Button } from "./"`.
-         *
-         * Example: { "src/components/*": "@ui/components" }
-         * Would rewrite imports for components located in `src/components` to `@ui/components` in
-         * generated code examples.
-         * `import { Button } from "./"` -> `import { Button } from "@ui/components/Button"`
-         */
-        importPaths?: Record<string, string>;
-        /**
-         * For import resolution - this is a temporary solution to support projects that use
-         * pnpm workspaces, as the compiler doesn't seem to be able to resolve imports when
-         * the package in node_modules is a symlink. Need to look into this more and find a
-         * better solution.
-         */
-        paths?: Record<string, string[]>;
-    };
-}
-export declare function getGitRemoteURL(repoPath: string): string;
-/**
- * Finds the URL of a remote file
- * @param filePath absolute file path on disk
- * @param repoURL remote URL
- * @returns
- */
-export declare function getRemoteFileUrl(filePath: string, repoURL?: string): string;
-export interface ProjectInfo {
-    /**
-     * Absolute path of the project directory
-     */
-    absPath: string;
-    /**
-     * An array of all tsx files in the project
-     */
-    files: string[];
-    /**
-     * The git remote URL of the project
-     */
-    remoteUrl: string;
-    /**
-     * The parsed Code Connect config file
-     */
-    config?: CodeConnectConfig;
-    /**
-     * TS program containing all tsx files in the project
-     */
-    tsProgram: ts.Program;
-}
-/**
- * Gets information about a project from a directory.
- *
- * @param dir Directory containing the project
- * @param configPath Optional path to Code Connect config file
- * @returns Object containing information about the project
- */
-export declare function getProjectInfo(dir: string, configPath?: string): ProjectInfo;
-export declare function resolveImportPath(filePath: string, config: CodeConnectConfig): string | null;
-//# sourceMappingURL=project.d.ts.map

package/dist/common/project.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../src/common/project.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,YAAY,CAAA;AAI3B,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjD;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;;;;;;;WASG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACpC;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KACjC,CAAA;CACF;AAqBD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,UAW/C;AAkBD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,UAqBlE;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAA;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B;;OAEG;IACH,SAAS,EAAE,EAAE,CAAC,OAAO,CAAA;CACtB;AAMD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CA4D5E;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI,CA0B5F"}

package/dist/common/project.js

@@ -1,179 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveImportPath = exports.getProjectInfo = exports.getRemoteFileUrl = exports.getGitRemoteURL = void 0;
-const child_process_1 = require("child_process");
-const glob_1 = require("glob");
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const typescript_1 = __importDefault(require("typescript"));
-const logging_1 = require("./logging");
-const DEFAULT_CONFIG_FILE_NAME = 'figma.config.json';
-function parseConfig(configFilePath) {
-    if (!fs_1.default.existsSync(configFilePath)) {
-        return undefined;
-    }
-    try {
-        const rawData = fs_1.default.readFileSync(configFilePath, 'utf-8');
-        const config = JSON.parse(rawData);
-        return config;
-    }
-    catch (error) {
-        console.error('Error parsing config file:', error);
-        return undefined;
-    }
-}
-function getGitRemoteURL(repoPath) {
-    try {
-        const spawn = (0, child_process_1.spawnSync)('git', ['config', '--get', 'remote.origin.url'], {
-            cwd: repoPath,
-        });
-        const output = spawn.stdout;
-        return (output || '').toString().trim();
-    }
-    catch (error) {
-        console.error('Error getting git remote URL:', error);
-        return '';
-    }
-}
-exports.getGitRemoteURL = getGitRemoteURL;
-/**
- * Uses `git rev-parse` to find absolute path to the root of the git repository
- */
-function getGitRepoAbsolutePath(filePath) {
-    try {
-        const spawn = (0, child_process_1.spawnSync)('git', ['rev-parse', '--show-toplevel'], {
-            cwd: path_1.default.dirname(filePath),
-        });
-        const output = spawn.stdout;
-        return (output || '').toString().trim();
-    }
-    catch (error) {
-        console.error('Error running `git rev-parse`:', error);
-        return '';
-    }
-}
-/**
- * Finds the URL of a remote file
- * @param filePath absolute file path on disk
- * @param repoURL remote URL
- * @returns
- */
-function getRemoteFileUrl(filePath, repoURL) {
-    if (!repoURL) {
-        return '';
-    }
-    let url = repoURL.trim();
-    url = url.replace(':', '/');
-    url = url.replace('git@', 'https://');
-    url = url.replace(/\.git$/, '');
-    // the folder of the git repo on disk could be named differently,
-    // so we need to find the relative path of the file to the root of the repo
-    // and append that to the remote URL
-    const repoAbsPath = getGitRepoAbsolutePath(filePath);
-    const index = filePath.indexOf(repoAbsPath);
-    if (index === -1) {
-        return '';
-    }
-    const relativeFilePath = filePath.substring(index + repoAbsPath.length);
-    return `${url}/tree/master${relativeFilePath}`;
-}
-exports.getRemoteFileUrl = getRemoteFileUrl;
-function mapToAbsolutePaths(globPaths, absPath) {
-    return globPaths.map((globPath) => `${absPath}/${globPath}`);
-}
-/**
- * Gets information about a project from a directory.
- *
- * @param dir Directory containing the project
- * @param configPath Optional path to Code Connect config file
- * @returns Object containing information about the project
- */
-function getProjectInfo(dir, configPath) {
-    const configFilePath = configPath
-        ? path_1.default.resolve(configPath)
-        : path_1.default.resolve(path_1.default.join(dir, DEFAULT_CONFIG_FILE_NAME));
-    const globalConfig = configFilePath ? parseConfig(configFilePath) : undefined;
-    const config = globalConfig?.codeConnect;
-    // `importPaths` and `paths` previously (incorrectly) lived in the global `codeConnect` config -
-    // some early users may have it defined here so we'll log this error message to notify them to move it
-    if (globalConfig && globalConfig.codeConnect.importPaths) {
-        logging_1.logger.error(`The 'importPaths' option in the config file should be specified under 'react'`);
-    }
-    if (globalConfig && globalConfig.codeConnect.paths) {
-        logging_1.logger.error(`The 'paths' option in the config file should be specified under 'react'`);
-    }
-    if (!globalConfig) {
-        logging_1.logger.info(`No config file found in ${dir}, proceeding with default options`);
-    }
-    else if (globalConfig && !config) {
-        logging_1.logger.info(`Config file found, but no options specified under 'codeConnect'. Parsing ${dir}`);
-    }
-    else if (config && !config.include) {
-        logging_1.logger.info(`Config file found, but no include globs specified. Parsing ${dir}`);
-    }
-    else {
-        logging_1.logger.info(`Config file found, parsing ${dir} using specified include globs`);
-    }
-    const absPath = path_1.default.resolve(dir);
-    const includeGlobs = config?.include
-        ? mapToAbsolutePaths(config.include, absPath)
-        : `${absPath}/**/*.{tsx,jsx}`;
-    const excludeGlobs = [
-        ...(config?.exclude ? mapToAbsolutePaths(config.exclude, absPath) : []),
-        `${absPath}/node_modules/**`,
-    ];
-    const files = (0, glob_1.globSync)(includeGlobs, {
-        nodir: true,
-        ignore: excludeGlobs,
-    });
-    const remoteUrl = getGitRemoteURL(absPath);
-    const compilerOptions = {
-        // This ensures the compiler can resolve imports such as "ui/button" when a
-        // baseUrl is configured in the tsconfig of the project. We probably want a more
-        // sophisticated way to parse the users tsconfig and pass it to the compiler eventually.
-        baseUrl: absPath,
-        // TODO: not sure why Node10 is needed her, but otherwise module resolution for
-        // pnpm workspaces won't work
-        moduleResolution: typescript_1.default.ModuleResolutionKind.Node10,
-        paths: config?.react?.paths ?? {},
-        allowJs: true,
-    };
-    const tsProgram = typescript_1.default.createProgram(files, compilerOptions);
-    return {
-        absPath,
-        files,
-        remoteUrl,
-        config,
-        tsProgram,
-    };
-}
-exports.getProjectInfo = getProjectInfo;
-function resolveImportPath(filePath, config) {
-    function isMatch(patternParts, pathParts) {
-        for (let i = 0; i < patternParts.length; i++) {
-            if (patternParts[i] !== '*' && patternParts[i] !== pathParts[i]) {
-                return false;
-            }
-        }
-        return true;
-    }
-    for (const [key, value] of Object.entries(config.react?.importPaths || {})) {
-        // Do a partial match from the end of the path
-        const patternParts = key.split('/').reverse();
-        const pathParts = filePath.split('/').reverse();
-        if (pathParts.length < patternParts.length) {
-            continue;
-        }
-        // If the mapped path ends with a wildcard we want to keep the filename in
-        // the final path (for non-index imports)
-        if (isMatch(patternParts, pathParts)) {
-            return value.endsWith('*') ? `${value.slice(0, -1)}${pathParts[0].split('.')[0]}` : value;
-        }
-    }
-    return null;
-}
-exports.resolveImportPath = resolveImportPath;
-//# sourceMappingURL=project.js.map

package/dist/common/project.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/common/project.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAyC;AACzC,+BAA+B;AAC/B,gDAAuB;AACvB,4CAAmB;AACnB,4DAA2B;AAC3B,uCAAkC;AAElC,MAAM,wBAAwB,GAAG,mBAAmB,CAAA;AAiDpD,SAAS,WAAW,CAAC,cAAsB;IACzC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QACnC,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;QACxD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAClC,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;QAClD,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,mBAAmB,CAAC,EAAE;YACvE,GAAG,EAAE,QAAQ;SACd,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC3B,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAA;QACrD,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC;AAXD,0CAWC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAE;YAC/D,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;SAC5B,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC3B,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAA;QACtD,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,QAAgB,EAAE,OAAgB;IACjE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,CAAA;IACX,CAAC;IAED,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IACxB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC3B,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACrC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAE/B,iEAAiE;IACjE,2EAA2E;IAC3E,oCAAoC;IACpC,MAAM,WAAW,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAA;IACpD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACjB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEvE,OAAO,GAAG,GAAG,eAAe,gBAAgB,EAAE,CAAA;AAChD,CAAC;AArBD,4CAqBC;AAyBD,SAAS,kBAAkB,CAAC,SAAmB,EAAE,OAAe;IAC9D,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,GAAW,EAAE,UAAmB;IAC7D,MAAM,cAAc,GAAG,UAAU;QAC/B,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC;QAC1B,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAA;IAC1D,MAAM,YAAY,GAAG,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7E,MAAM,MAAM,GAAG,YAAY,EAAE,WAAW,CAAA;IAExC,gGAAgG;IAChG,sGAAsG;IACtG,IAAI,YAAY,IAAK,YAAY,CAAC,WAAmB,CAAC,WAAW,EAAE,CAAC;QAClE,gBAAM,CAAC,KAAK,CAAC,+EAA+E,CAAC,CAAA;IAC/F,CAAC;IAED,IAAI,YAAY,IAAK,YAAY,CAAC,WAAmB,CAAC,KAAK,EAAE,CAAC;QAC5D,gBAAM,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAA;IACzF,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,gBAAM,CAAC,IAAI,CAAC,2BAA2B,GAAG,mCAAmC,CAAC,CAAA;IAChF,CAAC;SAAM,IAAI,YAAY,IAAI,CAAC,MAAM,EAAE,CAAC;QACnC,gBAAM,CAAC,IAAI,CAAC,4EAA4E,GAAG,EAAE,CAAC,CAAA;IAChG,CAAC;SAAM,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACrC,gBAAM,CAAC,IAAI,CAAC,8DAA8D,GAAG,EAAE,CAAC,CAAA;IAClF,CAAC;SAAM,CAAC;QACN,gBAAM,CAAC,IAAI,CAAC,8BAA8B,GAAG,gCAAgC,CAAC,CAAA;IAChF,CAAC;IAED,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACjC,MAAM,YAAY,GAAG,MAAM,EAAE,OAAO;QAClC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;QAC7C,CAAC,CAAC,GAAG,OAAO,iBAAiB,CAAA;IAC/B,MAAM,YAAY,GAAG;QACnB,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,GAAG,OAAO,kBAAkB;KAC7B,CAAA;IACD,MAAM,KAAK,GAAG,IAAA,eAAQ,EAAC,YAAY,EAAE;QACnC,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,YAAY;KACrB,CAAC,CAAA;IACF,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;IAC1C,MAAM,eAAe,GAAuB;QAC1C,2EAA2E;QAC3E,gFAAgF;QAChF,wFAAwF;QACxF,OAAO,EAAE,OAAO;QAChB,+EAA+E;QAC/E,6BAA6B;QAC7B,gBAAgB,EAAE,oBAAE,CAAC,oBAAoB,CAAC,MAAM;QAChD,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE;QACjC,OAAO,EAAE,IAAI;KACd,CAAA;IACD,MAAM,SAAS,GAAG,oBAAE,CAAC,aAAa,CAAC,KAAK,EAAE,eAAe,CAAC,CAAA;IAE1D,OAAO;QACL,OAAO;QACP,KAAK;QACL,SAAS;QACT,MAAM;QACN,SAAS;KACV,CAAA;AACH,CAAC;AA5DD,wCA4DC;AAED,SAAgB,iBAAiB,CAAC,QAAgB,EAAE,MAAyB;IAC3E,SAAS,OAAO,CAAC,YAAsB,EAAE,SAAmB;QAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7C,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChE,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3E,8CAA8C;QAC9C,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;QAC7C,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;QAC/C,IAAI,SAAS,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YAC3C,SAAQ;QACV,CAAC;QAED,0EAA0E;QAC1E,yCAAyC;QACzC,IAAI,OAAO,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;QAC3F,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AA1BD,8CA0BC"}