@zeroheight/adoption-cli 0.2.10 → 0.2.12

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Release notes
+
+## [0.2.12](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.12) - 24th July 2024
+- Update release notes
+
+## [0.2.11](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.11) - 24th July 2024
+- Add accessible release notes
+
+## [0.2.10](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.10) - 15th July 2024
+- Add ability to reset authentication credentials
+
+## [0.2.9](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.9) - 20th June 2024
+- Update documentation links
+
+## [0.2.8](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.8) - 19th June 2024
+- Bug fixes
+
+## [0.2.7](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.7) - 19th June 2024
+- Bug fixes
+
+## [0.2.6](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.6) - 19th June 2024
+- Bug fixes
+
+## [0.2.5](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.5) - 14th June 2024
+- Add more support for TypeScript files
+- Allow `--ignore` to be passed as an option
+
+## [0.2.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.2.0) - 10th June 2024
+- Add ability to define name of repository being analyzed
+
+## [0.1.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.1.1) - 3rd June 2024
+- Initial package set up

package/README.md

@@ -1,6 +1,8 @@
 # @zeroheight/adoption-cli
 
-CLI for measuring component usage
+CLI for measuring component usage to view in your [zeroheight](https://zeroheight.com/) account.
+
+See release notes [here](https://www.npmjs.com/package/@zeroheight/adoption-cli?activeTab=code)
 
 ## Install
 
@@ -16,7 +18,7 @@ In the repository in which you wish to analyze the component usage, run the foll
 zh-adoption analyze
 ```
 
-To send adoption data to your zeroheight account you will need to authenticate. This can be done as part of the `analyze` flow or separately by running:
+To send adoption data to your [zeroheight](https://zeroheight.com/) account you will need to authenticate. This can be done as part of the `analyze` flow or separately by running:
 
 ```
 zh-adoption auth

package/dist/cli.js

@@ -10,7 +10,7 @@ const { output, cleanup } = render(React.createElement(HelpInfo, null));
 program
     .name("zh-adoption")
     .description("CLI for measuring design system usage usage in your products")
-    .version("0.2.10")
+    .version("0.2.12")
     .addHelpText("before", output)
     .addCommand(analyzeCommand())
     .addCommand(authCommand());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroheight/adoption-cli",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "license": "ISC",
   "main": "dist/cli.js",
   "bin": {
@@ -21,7 +21,8 @@
     "test": "vitest"
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "dependencies": {
     "acorn": "^8.11.3",

package/dist/ast/html/analyzer.d.ts

@@ -1,3 +0,0 @@
-import { Root } from "hast";
-import { RawUsage } from "../analyze.js";
-export declare function analyze(tree: Root): RawUsage[];

package/dist/ast/html/analyzer.js

@@ -1,57 +0,0 @@
-import { visit } from "unist-util-visit";
-import { visit as visitEstree } from "estree-util-visit";
-import { transformVisitorStateToRawUsage, } from "../analyze.js";
-import { parse as parseTSJS } from "../ts-js/parser.js";
-export function analyze(tree) {
-    /**
-     * TODO: Populating imports means parsing JS files directly and finding:
-     * window.customElements.define('my-custom-element', MyCustomElement);
-     */
-    const state = {
-        components: new Map(),
-        imports: new Map(),
-    };
-    const rawPaths = [];
-    visit(tree, (node) => {
-        if (node.type !== "element")
-            return;
-        if (node.tagName === "script") {
-            rawPaths.push(...analyzeScript(node));
-            return;
-        }
-        const isCustomElement = node.tagName.includes("-");
-        if (!isCustomElement)
-            return;
-        state.components.set(node.tagName, (state.components.get(node.tagName) ?? 0) + 1);
-        // Dumb way of guessing import name
-        rawPaths.forEach((p) => {
-            if (p.includes(node.tagName)) {
-                state.imports.set(node.tagName, {
-                    name: node.tagName,
-                    package: p,
-                });
-            }
-        });
-    });
-    return transformVisitorStateToRawUsage(state);
-}
-function analyzeScript(node) {
-    const importPaths = [];
-    const rawCode = node.children
-        .filter((child) => child.type === "text")
-        .map((child) => child.value)
-        .join("\n");
-    const tree = parseTSJS(rawCode, {
-        type: "ts-js",
-        version: "latest",
-    });
-    visitEstree(tree, (jsNode) => {
-        if (jsNode.type !== "ImportDeclaration")
-            return;
-        const rawPath = jsNode.source.value;
-        if (typeof rawPath === "string") {
-            importPaths.push(rawPath);
-        }
-    });
-    return importPaths;
-}

package/dist/ast/html/parser.d.ts

@@ -1,4 +0,0 @@
-export interface HTMLOptions {
-    type: "html";
-}
-export declare function parse(code: string, _options?: HTMLOptions): import("hast").Root;

package/dist/ast/html/parser.js

@@ -1,6 +0,0 @@
-import { unified } from "unified";
-import rehypeParse from "rehype-parse";
-export function parse(code, _options) {
-    const tree = unified().use(rehypeParse, { fragment: true }).parse(code);
-    return tree;
-}

package/dist/ast/ts-js/analyzer.d.ts

@@ -1,2 +0,0 @@
-import type { Node } from "acorn";
-export declare function analyze(ast: Node): import("../analyze.js").RawUsage[];

package/dist/ast/ts-js/analyzer.js

@@ -1,73 +0,0 @@
-import * as walk from "acorn-walk";
-import { transformVisitorStateToRawUsage } from "../analyze.js";
-export function analyze(ast) {
-    const visitorState = {
-        components: new Map(),
-        imports: new Map(),
-    };
-    const visitors = {
-        JSXElement(node, state, _nodePath) {
-            const el = node.openingElement;
-            const elName = el.name.name;
-            if (!elName)
-                return;
-            // Ignore html tags e.g. div, h1, span
-            if (elName[0] === elName[0]?.toLocaleLowerCase())
-                return;
-            state.components.set(elName, (state.components.get(elName) ?? 0) + 1);
-        },
-        ImportDeclaration(node, state, _nodePath) {
-            const packageName = node.source.value;
-            node.specifiers.forEach((specifier) => {
-                // not handling namespace imports as we can't determine the actual name
-                // e.g. import * as MyIconLibrary from 'my-icon-library'
-                if (specifier.type === "ImportNamespaceSpecifier") {
-                    return;
-                }
-                let name = specifier.local.name;
-                if (specifier.type === "ImportDefaultSpecifier") {
-                    // handles the following cases:
-                    // import Icon from 'my-icon-library'
-                    name = specifier.local.name;
-                }
-                else if (specifier.type === "ImportSpecifier") {
-                    // handles the following cases:
-                    // import { Icon } from 'my-icon-library'
-                    // import { Icon as MyIcon } from 'my-icon-library'
-                    name =
-                        specifier.imported.type === "Literal"
-                            ? specifier.imported.value
-                            : specifier.imported.name;
-                }
-                state.imports.set(specifier.local.name, {
-                    package: packageName,
-                    name,
-                });
-            });
-        },
-    };
-    const base = {
-        ...walk.base,
-        TSInterfaceDeclaration() { },
-        TSModuleDeclaration() { },
-        TSAsExpression() { },
-        TSDeclareFunction() { },
-        TSTypeAliasDeclaration() { },
-        TSNonNullExpression() { },
-        TSEnumDeclaration() { },
-        TSParameterProperty() { },
-        TSImportEqualsDeclaration() { },
-        TSInstantiationExpression() { },
-        TSDeclareMethod() { },
-    };
-    try {
-        walk.ancestor(ast, visitors, base, visitorState);
-    }
-    catch (e) {
-        // We don't want to log the error to the users - maybe could add some actually logging in the future
-        // console.log("error", e);
-    }
-    finally {
-        return transformVisitorStateToRawUsage(visitorState);
-    }
-}

package/dist/ast/ts-js/parser.d.ts

@@ -1,6 +0,0 @@
-import * as acorn from "acorn";
-export interface TSJSOptions {
-    type: "ts-js";
-    version?: acorn.ecmaVersion;
-}
-export declare function parse(code: string, options?: TSJSOptions): acorn.Program;

package/dist/ast/ts-js/parser.js

@@ -1,14 +0,0 @@
-import * as acorn from "acorn";
-import { tsPlugin } from "acorn-typescript";
-import * as walk from "acorn-walk";
-import { extend } from "acorn-jsx-walk";
-export function parse(code, options) {
-    const typescriptPlugin = tsPlugin();
-    extend(walk.base);
-    const JSXParser = acorn.Parser.extend(typescriptPlugin);
-    return JSXParser.parse(code, {
-        ecmaVersion: options?.version ?? "latest",
-        sourceType: "module",
-        locations: true,
-    });
-}