@hero-design/snowflake-guard 1.2.4-alpha.4 → 1.2.4

package/README.md

@@ -10,8 +10,6 @@
 cp .env.example .env
 ```
 
-For React Native projects, include your repo name in the `MOBILE_REPO_NAMES` env.
-
 2. Set up [internal-tool-integrations service](https://github.com/Thinkei/internal-tool-integrations) for the bot to store report.
 
 - Replace `DB_HOST` with the host of the internal-tool-integrations service.

package/lib/src/index.js

@@ -11,14 +11,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-const parseMobileSource_1 = __importDefault(require("./parseMobileSource"));
 const parseSource_1 = __importDefault(require("./parseSource"));
 const constants_1 = require("./reports/constants");
 const fetchGraphql_1 = __importDefault(require("./graphql/fetchGraphql"));
 const queryGenerators_1 = require("./graphql/queryGenerators");
 const getDiffLocs_1 = require("./utils/getDiffLocs");
 const TSX_REGEX = /\.tsx$/;
-const TSX_AND_JSX_REGEX = /\.(tsx|jsx|js)$/;
 const TEST_REGEX = /__tests__/;
 const SNOWFLAKE_COMMENTS = {
     style: 'Snowflake detected! A component is customized using inline styles. Make sure to not use [prohibited CSS properties](https://docs.google.com/spreadsheets/d/1Dj8vqLdFaf-CSaSVoYqyYZIkGqF6OoyP7K4G1_9L62U/edit?usp=sharing).',
@@ -26,7 +24,6 @@ const SNOWFLAKE_COMMENTS = {
     'styled-component': 'Please do not use styled-component to customize this component, use sx prop or inline style instead.',
     className: `Please make sure that this className is not used as a CSS classname for component customization purposes, use sx prop or inline style instead. In case this is none-css classname, please flag it with this comment \`${constants_1.APPROVED_CLASSNAME_COMMENT}\`.`,
 };
-const MOBILE_REPO_NAMES = JSON.parse(process.env.MOBILE_REPO_NAMES || '[]');
 const checkIfDetectedSnowflakesInDiff = (diffLocs, locToComment) => {
     const locIdx = diffLocs.findIndex(([start, end]) => {
         return locToComment >= start && locToComment <= end;
@@ -45,19 +42,16 @@ module.exports = (app) => {
         const prBranch = context.payload.pull_request.head.ref;
         // List all changed files
         const prFiles = yield context.octokit.pulls.listFiles(Object.assign(Object.assign({}, repoInfo), { pull_number: prNumber }));
-        const isMobile = MOBILE_REPO_NAMES.includes(context.payload.repository.name);
-        const parseSource = isMobile ? parseMobileSource_1.default : parseSource_1.default;
-        const SOURCE_REGEX = isMobile ? TSX_AND_JSX_REGEX : TSX_REGEX;
-        const sourceFiles = prFiles.data.filter((file) => SOURCE_REGEX.test(file.filename) &&
+        const tsxFiles = prFiles.data.filter((file) => TSX_REGEX.test(file.filename) &&
             !TEST_REGEX.test(file.filename) &&
             file.status !== 'removed');
         // Saving file patches to get diff locations
-        const prFilePatches = sourceFiles.reduce((acc, file) => {
+        const prFilePatches = tsxFiles.reduce((acc, file) => {
             acc[file.filename] = file.patch || '';
             return acc;
         }, {});
         // Get file contents
-        const prFileContentPromises = sourceFiles.map((file) => context.octokit.repos.getContent(Object.assign(Object.assign({}, repoInfo), { path: file.filename, ref: prBranch })));
+        const prFileContentPromises = tsxFiles.map((file) => context.octokit.repos.getContent(Object.assign(Object.assign({}, repoInfo), { path: file.filename, ref: prBranch })));
         const prFileContents = yield Promise.all(prFileContentPromises);
         const snowflakeComments = [];
         const approvedSnowflakeLocs = [];
@@ -71,7 +65,7 @@ module.exports = (app) => {
             // @ts-ignore
             file.data.content, 'base64').toString();
             // Parse file content to check for snowflakes
-            const snowflakeReport = parseSource(stringContent);
+            const snowflakeReport = (0, parseSource_1.default)(stringContent);
             snowflakeReport.styleLocs.forEach((loc) => {
                 if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                     snowflakeComments.push({
@@ -81,6 +75,15 @@ module.exports = (app) => {
                     });
                 }
             });
+            snowflakeReport.sxLocs.forEach((loc) => {
+                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
+                    snowflakeComments.push({
+                        path: filePath,
+                        body: SNOWFLAKE_COMMENTS['sx'],
+                        line: loc,
+                    });
+                }
+            });
             snowflakeReport.styledComponentLocs.forEach((loc) => {
                 if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                     snowflakeComments.push({
@@ -90,31 +93,20 @@ module.exports = (app) => {
                     });
                 }
             });
+            snowflakeReport.classNameLocs.forEach((loc) => {
+                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
+                    snowflakeComments.push({
+                        path: filePath,
+                        body: SNOWFLAKE_COMMENTS['className'],
+                        line: loc,
+                    });
+                }
+            });
             snowflakeReport.approvedLocs.forEach((loc) => {
                 if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                     approvedSnowflakeLocs.push(loc);
                 }
             });
-            if (!isMobile) {
-                snowflakeReport.sxLocs.forEach((loc) => {
-                    if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-                        snowflakeComments.push({
-                            path: filePath,
-                            body: SNOWFLAKE_COMMENTS['sx'],
-                            line: loc,
-                        });
-                    }
-                });
-                snowflakeReport.classNameLocs.forEach((loc) => {
-                    if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-                        snowflakeComments.push({
-                            path: filePath,
-                            body: SNOWFLAKE_COMMENTS['className'],
-                            line: loc,
-                        });
-                    }
-                });
-            }
         }));
         // Saving report
         const snowflakeCount = snowflakeComments.length;

package/lib/src/reports/mobile/constants.d.ts

@@ -82,179 +82,4 @@ declare const MOBILE_RULESET_MAP: {
     'Typography.Caption': string[];
     'Typography.Label': string[];
 };
-declare const BAR_STYLE_RULESET_MAP: {
-    Tabs: string[];
-    'Tabs.Scroll': string[];
-};
-declare const CONTAINER_STYLE_RULESET_MAP: {
-    Tabs: string[];
-    'Tabs.Scroll': string[];
-};
-declare const TEXT_STYLE_RULESET_MAP: {
-    'Toolbar.Message': {
-        [x: number]: string;
-        length: number;
-        toString(): string;
-        toLocaleString(): string;
-        pop(): string | undefined;
-        push(...items: string[]): number;
-        concat(...items: ConcatArray<string>[]): string[];
-        concat(...items: (string | ConcatArray<string>)[]): string[];
-        join(separator?: string | undefined): string;
-        reverse(): string[];
-        shift(): string | undefined;
-        slice(start?: number | undefined, end?: number | undefined): string[];
-        sort(compareFn?: ((a: string, b: string) => number) | undefined): string[];
-        splice(start: number, deleteCount?: number | undefined): string[];
-        splice(start: number, deleteCount: number, ...items: string[]): string[];
-        unshift(...items: string[]): number;
-        indexOf(searchElement: string, fromIndex?: number | undefined): number;
-        lastIndexOf(searchElement: string, fromIndex?: number | undefined): number;
-        every<S extends string>(predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): this is S[];
-        every(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        some(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        forEach(callbackfn: (value: string, index: number, array: string[]) => void, thisArg?: any): void;
-        map<U>(callbackfn: (value: string, index: number, array: string[]) => U, thisArg?: any): U[];
-        filter<S_1 extends string>(predicate: (value: string, index: number, array: string[]) => value is S_1, thisArg?: any): S_1[];
-        filter(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[];
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduce<U_1>(callbackfn: (previousValue: U_1, currentValue: string, currentIndex: number, array: string[]) => U_1, initialValue: U_1): U_1;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduceRight<U_2>(callbackfn: (previousValue: U_2, currentValue: string, currentIndex: number, array: string[]) => U_2, initialValue: U_2): U_2;
-        find<S_2 extends string>(predicate: (this: void, value: string, index: number, obj: string[]) => value is S_2, thisArg?: any): S_2 | undefined;
-        find(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string | undefined;
-        findIndex(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): number;
-        fill(value: string, start?: number | undefined, end?: number | undefined): string[];
-        copyWithin(target: number, start: number, end?: number | undefined): string[];
-        entries(): IterableIterator<[number, string]>;
-        keys(): IterableIterator<number>;
-        values(): IterableIterator<string>;
-        includes(searchElement: string, fromIndex?: number | undefined): boolean;
-        flatMap<U_3, This = undefined>(callback: (this: This, value: string, index: number, array: string[]) => U_3 | readonly U_3[], thisArg?: This | undefined): U_3[];
-        flat<A, D extends number = 1>(this: A, depth?: D | undefined): FlatArray<A, D>[];
-        [Symbol.iterator](): IterableIterator<string>;
-        [Symbol.unscopables](): {
-            copyWithin: boolean;
-            entries: boolean;
-            fill: boolean;
-            find: boolean;
-            findIndex: boolean;
-            keys: boolean;
-            values: boolean;
-        };
-        at(index: number): string | undefined;
-    };
-    TextInput: {
-        [x: number]: string;
-        length: number;
-        toString(): string;
-        toLocaleString(): string;
-        pop(): string | undefined;
-        push(...items: string[]): number;
-        concat(...items: ConcatArray<string>[]): string[];
-        concat(...items: (string | ConcatArray<string>)[]): string[];
-        join(separator?: string | undefined): string;
-        reverse(): string[];
-        shift(): string | undefined;
-        slice(start?: number | undefined, end?: number | undefined): string[];
-        sort(compareFn?: ((a: string, b: string) => number) | undefined): string[];
-        splice(start: number, deleteCount?: number | undefined): string[];
-        splice(start: number, deleteCount: number, ...items: string[]): string[];
-        unshift(...items: string[]): number;
-        indexOf(searchElement: string, fromIndex?: number | undefined): number;
-        lastIndexOf(searchElement: string, fromIndex?: number | undefined): number;
-        every<S extends string>(predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): this is S[];
-        every(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        some(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        forEach(callbackfn: (value: string, index: number, array: string[]) => void, thisArg?: any): void;
-        map<U>(callbackfn: (value: string, index: number, array: string[]) => U, thisArg?: any): U[];
-        filter<S_1 extends string>(predicate: (value: string, index: number, array: string[]) => value is S_1, thisArg?: any): S_1[];
-        filter(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[];
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduce<U_1>(callbackfn: (previousValue: U_1, currentValue: string, currentIndex: number, array: string[]) => U_1, initialValue: U_1): U_1;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduceRight<U_2>(callbackfn: (previousValue: U_2, currentValue: string, currentIndex: number, array: string[]) => U_2, initialValue: U_2): U_2;
-        find<S_2 extends string>(predicate: (this: void, value: string, index: number, obj: string[]) => value is S_2, thisArg?: any): S_2 | undefined;
-        find(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string | undefined;
-        findIndex(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): number;
-        fill(value: string, start?: number | undefined, end?: number | undefined): string[];
-        copyWithin(target: number, start: number, end?: number | undefined): string[];
-        entries(): IterableIterator<[number, string]>;
-        keys(): IterableIterator<number>;
-        values(): IterableIterator<string>;
-        includes(searchElement: string, fromIndex?: number | undefined): boolean;
-        flatMap<U_3, This = undefined>(callback: (this: This, value: string, index: number, array: string[]) => U_3 | readonly U_3[], thisArg?: This | undefined): U_3[];
-        flat<A, D extends number = 1>(this: A, depth?: D | undefined): FlatArray<A, D>[];
-        [Symbol.iterator](): IterableIterator<string>;
-        [Symbol.unscopables](): {
-            copyWithin: boolean;
-            entries: boolean;
-            fill: boolean;
-            find: boolean;
-            findIndex: boolean;
-            keys: boolean;
-            values: boolean;
-        };
-        at(index: number): string | undefined;
-    };
-    'Search.OneLine': {
-        [x: number]: string;
-        length: number;
-        toString(): string;
-        toLocaleString(): string;
-        pop(): string | undefined;
-        push(...items: string[]): number;
-        concat(...items: ConcatArray<string>[]): string[];
-        concat(...items: (string | ConcatArray<string>)[]): string[];
-        join(separator?: string | undefined): string;
-        reverse(): string[];
-        shift(): string | undefined;
-        slice(start?: number | undefined, end?: number | undefined): string[];
-        sort(compareFn?: ((a: string, b: string) => number) | undefined): string[];
-        splice(start: number, deleteCount?: number | undefined): string[];
-        splice(start: number, deleteCount: number, ...items: string[]): string[];
-        unshift(...items: string[]): number;
-        indexOf(searchElement: string, fromIndex?: number | undefined): number;
-        lastIndexOf(searchElement: string, fromIndex?: number | undefined): number;
-        every<S extends string>(predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): this is S[];
-        every(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        some(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        forEach(callbackfn: (value: string, index: number, array: string[]) => void, thisArg?: any): void;
-        map<U>(callbackfn: (value: string, index: number, array: string[]) => U, thisArg?: any): U[];
-        filter<S_1 extends string>(predicate: (value: string, index: number, array: string[]) => value is S_1, thisArg?: any): S_1[];
-        filter(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[];
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduce<U_1>(callbackfn: (previousValue: U_1, currentValue: string, currentIndex: number, array: string[]) => U_1, initialValue: U_1): U_1;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduceRight<U_2>(callbackfn: (previousValue: U_2, currentValue: string, currentIndex: number, array: string[]) => U_2, initialValue: U_2): U_2;
-        find<S_2 extends string>(predicate: (this: void, value: string, index: number, obj: string[]) => value is S_2, thisArg?: any): S_2 | undefined;
-        find(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string | undefined;
-        findIndex(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): number;
-        fill(value: string, start?: number | undefined, end?: number | undefined): string[];
-        copyWithin(target: number, start: number, end?: number | undefined): string[];
-        entries(): IterableIterator<[number, string]>;
-        keys(): IterableIterator<number>;
-        values(): IterableIterator<string>;
-        includes(searchElement: string, fromIndex?: number | undefined): boolean;
-        flatMap<U_3, This = undefined>(callback: (this: This, value: string, index: number, array: string[]) => U_3 | readonly U_3[], thisArg?: This | undefined): U_3[];
-        flat<A, D extends number = 1>(this: A, depth?: D | undefined): FlatArray<A, D>[];
-        [Symbol.iterator](): IterableIterator<string>;
-        [Symbol.unscopables](): {
-            copyWithin: boolean;
-            entries: boolean;
-            fill: boolean;
-            find: boolean;
-            findIndex: boolean;
-            keys: boolean;
-            values: boolean;
-        };
-        at(index: number): string | undefined;
-    };
-};
-export { HD_MOBILE_COMPONENTS, MOBILE_RULESET_MAP, BAR_STYLE_RULESET_MAP, CONTAINER_STYLE_RULESET_MAP, TEXT_STYLE_RULESET_MAP, };
+export { HD_MOBILE_COMPONENTS, MOBILE_RULESET_MAP };

package/lib/src/reports/mobile/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEXT_STYLE_RULESET_MAP = exports.CONTAINER_STYLE_RULESET_MAP = exports.BAR_STYLE_RULESET_MAP = exports.MOBILE_RULESET_MAP = exports.HD_MOBILE_COMPONENTS = void 0;
+exports.MOBILE_RULESET_MAP = exports.HD_MOBILE_COMPONENTS = void 0;
 const PADDING_ATTRS = [
     'padding',
     'paddingBottom',
@@ -347,83 +347,42 @@ const MOBILE_RULESET_MAP = {
         ...HEIGHT_ATTRS,
     ],
     'Toast.Container': [
-        ...COMMON_PROHIBITED_ATTRS,
-        ...WIDTH_ATTRS,
+        ...PADDING_ATTRS,
+        ...BORDER_ATTRS,
+        ...SHADOW_ATTRS,
+        ...TEXT_ATTRS,
         ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
     ],
     'Toast.Provider': [
-        ...COMMON_PROHIBITED_ATTRS,
-        ...WIDTH_ATTRS,
-        ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
-    ],
-    'Toolbar.Group': [
-        ...COMMON_PROHIBITED_ATTRS,
-        ...WIDTH_ATTRS,
-        ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
-    ],
-    'Toolbar.Item': [
-        ...COMMON_PROHIBITED_ATTRS,
-        ...WIDTH_ATTRS,
-        ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
-    ],
-    'Toolbar.Message': [
-        ...COMMON_PROHIBITED_ATTRS,
-        ...WIDTH_ATTRS,
-        ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
-    ],
-    'Typography.Body': [...COMMON_PROHIBITED_ATTRS, ...HEIGHT_ATTRS],
-    'Typography.Caption': [...COMMON_PROHIBITED_ATTRS, ...HEIGHT_ATTRS],
-    'Typography.Label': [...COMMON_PROHIBITED_ATTRS, ...HEIGHT_ATTRS],
-};
-exports.MOBILE_RULESET_MAP = MOBILE_RULESET_MAP;
-const BAR_STYLE_RULESET_MAP = {
-    Tabs: [
         ...PADDING_ATTRS,
         ...BORDER_ATTRS,
-        ...TEXT_ATTRS,
         ...SHADOW_ATTRS,
-        ...WIDTH_ATTRS,
+        ...TEXT_ATTRS,
         ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
     ],
-    'Tabs.Scroll': [
+    'Toolbar.Group': [
         ...PADDING_ATTRS,
         ...BORDER_ATTRS,
-        ...TEXT_ATTRS,
         ...SHADOW_ATTRS,
-        ...WIDTH_ATTRS,
+        ...TEXT_ATTRS,
         ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
     ],
-};
-exports.BAR_STYLE_RULESET_MAP = BAR_STYLE_RULESET_MAP;
-const CONTAINER_STYLE_RULESET_MAP = {
-    Tabs: [
+    'Toolbar.Item': [
+        ...PADDING_ATTRS,
         ...BORDER_ATTRS,
-        ...TEXT_ATTRS,
         ...SHADOW_ATTRS,
-        ...WIDTH_ATTRS,
+        ...TEXT_ATTRS,
         ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
     ],
-    'Tabs.Scroll': [
+    'Toolbar.Message': [
+        ...PADDING_ATTRS,
         ...BORDER_ATTRS,
-        ...TEXT_ATTRS,
         ...SHADOW_ATTRS,
-        ...WIDTH_ATTRS,
+        ...TEXT_ATTRS,
         ...HEIGHT_ATTRS,
-        ...MARGIN_ATTRS,
     ],
+    'Typography.Body': [...COMMON_PROHIBITED_ATTRS, ...HEIGHT_ATTRS],
+    'Typography.Caption': [...COMMON_PROHIBITED_ATTRS, ...HEIGHT_ATTRS],
+    'Typography.Label': [...COMMON_PROHIBITED_ATTRS, ...HEIGHT_ATTRS],
 };
-exports.CONTAINER_STYLE_RULESET_MAP = CONTAINER_STYLE_RULESET_MAP;
-const TEXT_STYLE_RULESET_MAP = {
-    'Toolbar.Message': Object.assign(Object.assign(Object.assign(Object.assign({}, COMMON_PROHIBITED_ATTRS), WIDTH_ATTRS), HEIGHT_ATTRS), MARGIN_ATTRS),
-    TextInput: Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, PADDING_ATTRS), BORDER_ATTRS), SHADOW_ATTRS), TEXT_ATTRS), HEIGHT_ATTRS),
-    'Search.OneLine': Object.assign(Object.assign(Object.assign(Object.assign({}, COMMON_PROHIBITED_ATTRS), WIDTH_ATTRS), HEIGHT_ATTRS), MARGIN_ATTRS),
-};
-exports.TEXT_STYLE_RULESET_MAP = TEXT_STYLE_RULESET_MAP;
+exports.MOBILE_RULESET_MAP = MOBILE_RULESET_MAP;

package/lib/src/reports/mobile/reportStyledComponents.d.ts

@@ -1,6 +1,6 @@
 import * as recast from 'recast';
 import type { MobileComponentName } from './types';
 declare const reportStyledComponents: (ast: recast.types.ASTNode, componentList: {
-    [k: string]: "Accordion" | "Alert" | "Attachment" | "Avatar" | "Badge" | "BottomNavigation" | "BottomSheet" | "Box" | "Button" | "Calendar" | "Carousel" | "Card" | "Chip" | "Collapse" | "Checkbox" | "ContentNavigator" | "DatePicker" | "Divider" | "Drawer" | "Empty" | "Error" | "FAB" | "HeroDesignProvider" | "MapPin" | "Icon" | "Image" | "List" | "PinInput" | "Progress" | "Slider" | "Spinner" | "Swipeable" | "Radio" | "SectionHeading" | "Select" | "Skeleton" | "Success" | "Switch" | "Tabs" | "Tag" | "TextInput" | "TimePicker" | "Toast" | "Toolbar" | "Typography" | "Rate" | "RefreshControl" | "RichTextEditor" | "PageControl" | "Portal" | "ScrollViewWithFAB" | "SectionListWithFAB" | "FlatListWithFAB" | "Search" | "FloatingIsland";
+    [k: string]: "Alert" | "Badge" | "Button" | "Card" | "Carousel" | "Checkbox" | "Chip" | "Collapse" | "DatePicker" | "Divider" | "Empty" | "Icon" | "Portal" | "Progress" | "Radio" | "Rate" | "Select" | "Slider" | "Spinner" | "Switch" | "Tabs" | "Tag" | "TimePicker" | "Typography" | "Error" | "Image" | "Accordion" | "Attachment" | "Avatar" | "BottomNavigation" | "BottomSheet" | "Box" | "Calendar" | "ContentNavigator" | "Drawer" | "FAB" | "HeroDesignProvider" | "MapPin" | "List" | "PinInput" | "Swipeable" | "SectionHeading" | "Skeleton" | "Success" | "TextInput" | "Toast" | "Toolbar" | "RefreshControl" | "RichTextEditor" | "PageControl" | "ScrollViewWithFAB" | "SectionListWithFAB" | "FlatListWithFAB" | "Search" | "FloatingIsland";
 }, styledAliasName: string) => number[];
 export default reportStyledComponents;

package/lib/src/reports/reportCustomStyleProperties.d.ts

@@ -2,7 +2,7 @@ import * as recast from 'recast';
 import { AdditionalProp, InlineStyleProps } from './reportInlineStyle';
 import type { ComponentName, CompoundComponentName } from './types';
 declare const reportCustomProperties: (ast: recast.types.ASTNode, componentList: {
-    [k: string]: "Alert" | "Badge" | "Button" | "Carousel" | "Card" | "Chip" | "Collapse" | "Checkbox" | "DatePicker" | "Divider" | "Empty" | "Icon" | "Progress" | "Slider" | "Spinner" | "Radio" | "Select" | "Switch" | "Tabs" | "Tag" | "TimePicker" | "Typography" | "Rate" | "Portal" | "Banner" | "Breadcrumb" | "Chart" | "Comment" | "ContextPanel" | "Dropdown" | "File" | "Filters" | "Form" | "Grid" | "InPageNavigation" | "Input" | "MediaQuery" | "Menu" | "Modal" | "Notification" | "PageHeader" | "Pagination" | "Portlet" | "Result" | "SelectButton" | "SideBar" | "Statistic" | "Steps" | "Table" | "TagInput" | "Timeline" | "Tooltip" | "Widget";
+    [k: string]: "Alert" | "Badge" | "Banner" | "Breadcrumb" | "Button" | "Card" | "Carousel" | "Chart" | "Checkbox" | "Chip" | "Collapse" | "Comment" | "ContextPanel" | "DatePicker" | "Divider" | "Dropdown" | "Empty" | "File" | "Filters" | "Form" | "Grid" | "Icon" | "InPageNavigation" | "Input" | "MediaQuery" | "Menu" | "Modal" | "Notification" | "PageHeader" | "Pagination" | "Portal" | "Portlet" | "Progress" | "Radio" | "Rate" | "Result" | "Select" | "SelectButton" | "SideBar" | "Slider" | "Spinner" | "Statistic" | "Steps" | "Switch" | "Table" | "Tabs" | "Tag" | "TagInput" | "TimePicker" | "Timeline" | "Tooltip" | "Typography" | "Widget";
 }, commentList: {
     classNameCmts: number[];
     styleCmts: {

package/lib/src/reports/reportStyledComponents.d.ts

@@ -1,6 +1,6 @@
 import * as recast from 'recast';
 import type { ComponentName } from './types';
 declare const reportStyledComponents: (ast: recast.types.ASTNode, componentList: {
-    [k: string]: "Alert" | "Badge" | "Button" | "Carousel" | "Card" | "Chip" | "Collapse" | "Checkbox" | "DatePicker" | "Divider" | "Empty" | "Icon" | "Progress" | "Slider" | "Spinner" | "Radio" | "Select" | "Switch" | "Tabs" | "Tag" | "TimePicker" | "Typography" | "Rate" | "Portal" | "Banner" | "Breadcrumb" | "Chart" | "Comment" | "ContextPanel" | "Dropdown" | "File" | "Filters" | "Form" | "Grid" | "InPageNavigation" | "Input" | "MediaQuery" | "Menu" | "Modal" | "Notification" | "PageHeader" | "Pagination" | "Portlet" | "Result" | "SelectButton" | "SideBar" | "Statistic" | "Steps" | "Table" | "TagInput" | "Timeline" | "Tooltip" | "Widget";
+    [k: string]: "Alert" | "Badge" | "Banner" | "Breadcrumb" | "Button" | "Card" | "Carousel" | "Chart" | "Checkbox" | "Chip" | "Collapse" | "Comment" | "ContextPanel" | "DatePicker" | "Divider" | "Dropdown" | "Empty" | "File" | "Filters" | "Form" | "Grid" | "Icon" | "InPageNavigation" | "Input" | "MediaQuery" | "Menu" | "Modal" | "Notification" | "PageHeader" | "Pagination" | "Portal" | "Portlet" | "Progress" | "Radio" | "Rate" | "Result" | "Select" | "SelectButton" | "SideBar" | "Slider" | "Spinner" | "Statistic" | "Steps" | "Switch" | "Table" | "Tabs" | "Tag" | "TagInput" | "TimePicker" | "Timeline" | "Tooltip" | "Typography" | "Widget";
 }, styledAliasName: string) => number[];
 export default reportStyledComponents;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hero-design/snowflake-guard",
-  "version": "1.2.4-alpha.4",
+  "version": "1.2.4",
   "description": "A hero-design bot detecting snowflake usage",
   "author": "Hau Dao",
   "license": "ISC",

package/lib/src/parseMobileSource.d.ts

@@ -1,15 +0,0 @@
-import { InlineStyleProps } from './reports/mobile/reportInlineStyle';
-import type { CompoundMobileComponentName } from './reports/mobile/types';
-declare const parseMobileSource: (source: string) => {
-    styleLocs: number[];
-    styledComponentLocs: number[];
-    approvedLocs: number[];
-    violatingAttributes: {
-        attributeName: string;
-        attributeValue: string | null;
-        inlineStyleProps: InlineStyleProps;
-        componentName: CompoundMobileComponentName;
-        loc: number | undefined;
-    }[];
-};
-export default parseMobileSource;

package/lib/src/parseMobileSource.js

@@ -1,118 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const recast = __importStar(require("recast"));
-const flowParser = __importStar(require("./parsers/flow"));
-const tsParser = __importStar(require("./parsers/typescript"));
-const constants_1 = require("./reports/mobile/constants");
-const constants_2 = require("./reports/constants");
-const reportCustomStyleProperties_1 = __importDefault(require("./reports/mobile/reportCustomStyleProperties"));
-const reportStyledComponents_1 = __importDefault(require("./reports/mobile/reportStyledComponents"));
-const parseMobileSource = (source) => {
-    let hasHeroDesignImport = false;
-    let hasStyledComponentsImport = false;
-    const componentList = {};
-    let styledAliasName = 'styled';
-    let styledComponentLocs = [];
-    let styleLocs = [];
-    let violatingAttributes = [];
-    const approvedInlineStyleCmts = [];
-    const approvedStyledComponentLocs = [];
-    const ast = recast.parse(source, {
-        parser: source.includes('@flow') ? flowParser : tsParser,
-    });
-    recast.visit(ast, {
-        visitImportDeclaration(path) {
-            this.traverse(path);
-            const importedFrom = path.value.source.value;
-            // Check if file imports components from '@hero-design/rn'
-            if (importedFrom === '@hero-design/rn') {
-                recast.visit(path.node, {
-                    visitImportSpecifier(importPath) {
-                        this.traverse(importPath);
-                        if (constants_1.HD_MOBILE_COMPONENTS.includes(importPath.value.imported.name)) {
-                            componentList[importPath.value.local.name] =
-                                importPath.value.imported.name;
-                            hasHeroDesignImport = true;
-                        }
-                    },
-                });
-            }
-            // Check if file imports from '@emotion/native'
-            if (importedFrom === '@emotion/native') {
-                recast.visit(path.node, {
-                    visitImportDefaultSpecifier(importPath) {
-                        this.traverse(importPath);
-                        styledAliasName = importPath.value.local.name;
-                        hasStyledComponentsImport = true;
-                    },
-                });
-            }
-        },
-        visitComment(path) {
-            this.traverse(path);
-            const comment = path.value.value;
-            if (comment
-                .toLowerCase()
-                .includes(constants_2.APPROVED_INLINE_STYLE_COMMENT.toLowerCase())) {
-                approvedInlineStyleCmts.push({
-                    loc: path.value.loc.start.line,
-                    comment,
-                });
-            }
-            if (comment
-                .toLowerCase()
-                .includes(constants_2.APPROVED_STYLED_COMPONENTS_COMMENT.toLowerCase())) {
-                approvedStyledComponentLocs.push(path.value.loc.start.line);
-            }
-        },
-    });
-    const isNotApprovedStyledComponentSnowflakes = (loc) => !approvedStyledComponentLocs.includes(loc - 1);
-    if (hasHeroDesignImport) {
-        // Case 1: Using style object to customise components
-        const customPropLocs = (0, reportCustomStyleProperties_1.default)(ast, componentList, {
-            styleCmts: approvedInlineStyleCmts,
-        });
-        styleLocs = customPropLocs.style;
-        // Case 2: Using styled-components to customise components
-        if (hasStyledComponentsImport) {
-            styledComponentLocs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName).filter(isNotApprovedStyledComponentSnowflakes);
-        }
-        violatingAttributes = customPropLocs.violatingAttributes;
-    }
-    return {
-        styleLocs,
-        styledComponentLocs,
-        approvedLocs: [
-            ...approvedInlineStyleCmts.map((cmt) => cmt.loc),
-            ...approvedStyledComponentLocs,
-        ],
-        violatingAttributes,
-    };
-};
-exports.default = parseMobileSource;

package/lib/src/parsers/flow.d.ts

@@ -1,3 +0,0 @@
-import * as babelParser from '@babel/parser';
-import { Overrides } from 'recast/parsers/_babel_options';
-export declare const parse: (source: string, options?: Overrides) => babelParser.ParseResult<import("@babel/types").File>;

package/lib/src/parsers/flow.js

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parse = void 0;
-const babelParser = __importStar(require("@babel/parser"));
-const _babel_options_1 = __importDefault(require("recast/parsers/_babel_options"));
-const parse = (source, options) => {
-    const babelOptions = (0, _babel_options_1.default)(options);
-    babelOptions.plugins.push('jsx', 'flow');
-    return babelParser.parse(source, babelOptions);
-};
-exports.parse = parse;

package/lib/src/reports/mobile/__tests__/reportCustomStyleProperties.spec.d.ts

@@ -1 +0,0 @@
-export {};