@hero-design/snowflake-guard 1.0.7-alpha0

package/.dockerignore

@@ -0,0 +1,12 @@
+**/node_modules/
+**/.git
+**/README.md
+**/LICENSE
+**/.vscode
+**/npm-debug.log
+**/coverage
+**/.env
+**/.editorconfig
+**/dist
+**/*.pem
+Dockerfile

package/.env.example

@@ -0,0 +1,9 @@
+# The ID of your GitHub App
+APP_ID=
+WEBHOOK_SECRET=development
+
+# Use `trace` to get verbose logging or `info` to show less
+LOG_LEVEL=debug
+
+# Go to https://smee.io/new set this to the URL that you are redirected to.
+WEBHOOK_PROXY_URL=

package/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  extends: ['hd'],
+};

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# @hero-design/snowflake-guard
+
+## 1.0.7
+
+### Patch Changes
+
+- [#3126](https://github.com/Thinkei/hero-design/pull/3126) [`11e08d8c2`](https://github.com/Thinkei/hero-design/commit/11e08d8c244d0e7bf99e4ccb5a17aadf575bdda8) Thanks [@haudao-eh](https://github.com/haudao-eh)! - [ANG-2671] Allow to bypass snowflakes by comments
+
+## 1.0.6
+
+### Patch Changes
+
+- [#3103](https://github.com/Thinkei/hero-design/pull/3103) [`97bfc5144`](https://github.com/Thinkei/hero-design/commit/97bfc514495d50b7d36d0186764744b8244a9166) Thanks [@haudao-eh](https://github.com/haudao-eh)! - Fix getting wrong component name
+
+## 1.0.5
+
+### Patch Changes
+
+- [#3091](https://github.com/Thinkei/hero-design/pull/3091) [`fbb723675`](https://github.com/Thinkei/hero-design/commit/fbb7236755deb2b2b0bfdbe89154d727bc8f5d0e) Thanks [@haudao-eh](https://github.com/haudao-eh)! - Report snowflakes based on components' individual rulset
+
+- [#3078](https://github.com/Thinkei/hero-design/pull/3078) [`8d69517f1`](https://github.com/Thinkei/hero-design/commit/8d69517f16b249d6c3582af826b5ba6df30e1183) Thanks [@haudao-eh](https://github.com/haudao-eh)! - Remove frontend scripts
+
+- [#3095](https://github.com/Thinkei/hero-design/pull/3095) [`8a94a5213`](https://github.com/Thinkei/hero-design/commit/8a94a5213126aa154bf7d77c65abf650bab1349c) Thanks [@haudao-eh](https://github.com/haudao-eh)! - Update bot review behaviour
+
+## 1.0.4
+
+### Patch Changes
+
+- [#3070](https://github.com/Thinkei/hero-design/pull/3070) [`ca5b8f588`](https://github.com/Thinkei/hero-design/commit/ca5b8f5884de2e7c7445d032d4e34092883dd46c) Thanks [@haudao-eh](https://github.com/haudao-eh)! - [ANG-2641] Migrate snowflake script from frontend-script
+
+## 1.0.3
+
+### Patch Changes
+
+- [#2838](https://github.com/Thinkei/hero-design/pull/2838) [`b8ea41d92`](https://github.com/Thinkei/hero-design/commit/b8ea41d924f8b62d7fd4ff9a2418b27877ca8bda) Thanks [@haudao-eh](https://github.com/haudao-eh)! - Fix comment on wrong lines
+
+## 1.0.2
+
+### Patch Changes
+
+- [#2625](https://github.com/Thinkei/hero-design/pull/2625) [`4bb963963`](https://github.com/Thinkei/hero-design/commit/4bb963963d053604d3cb055b239174abab441271) Thanks [@haudao-eh](https://github.com/haudao-eh)! - Stop fetching removed files.
+
+## 1.0.1
+
+### Patch Changes
+
+- [#2530](https://github.com/Thinkei/hero-design/pull/2530) [`ec37290b4`](https://github.com/Thinkei/hero-design/commit/ec37290b4ea1d09f9034b024bf731c8dcdded7a7) Thanks [@haudao-eh](https://github.com/haudao-eh)! - [Snowflake Guard] Allow to comment on file when detected line is not part of the diff

package/Dockerfile

@@ -0,0 +1,8 @@
+FROM node:19-slim
+WORKDIR /usr/src/app
+COPY package.json package-lock.json ./
+RUN npm ci --production
+RUN npm cache clean --force
+ENV NODE_ENV="production"
+COPY . .
+CMD [ "npm", "start" ]

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2023, Hau Dao
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# @hero-design/snowflake-guard
+
+> A GitHub App built with [Probot](https://github.com/probot/probot) that A hero-design bot detecting snowflake usage
+
+## Setup
+
+```sh
+# Install dependencies
+npm install
+
+# Run the bot
+npm start
+```
+
+## Docker
+
+```sh
+# 1. Build container
+docker build -t @hero-design/snowflake-guard .
+
+# 2. Start container
+docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> @hero-design/snowflake-guard
+```
+
+## Contributing
+
+If you have suggestions for how @hero-design/snowflake-guard could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
+
+For more, check out the [Contributing Guide](CONTRIBUTING.md).
+
+## License
+
+[ISC](LICENSE) © 2023 Hau Dao

package/app.yml

@@ -0,0 +1,137 @@
+# This is a GitHub App Manifest. These settings will be used by default when
+# initially configuring your GitHub App.
+#
+# NOTE: changing this file will not update your GitHub App settings.
+# You must visit github.com/settings/apps/your-app-name to edit them.
+#
+# Read more about configuring your GitHub App:
+# https://probot.github.io/docs/development/#configuring-a-github-app
+#
+# Read more about GitHub App Manifests:
+# https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/
+
+# The list of events the GitHub App subscribes to.
+# Uncomment the event names below to enable them.
+default_events:
+  # - check_run
+  # - check_suite
+  # - commit_comment
+  # - create
+  # - delete
+  # - deployment
+  # - deployment_status
+  # - fork
+  # - gollum
+  # - issue_comment
+  # - issues
+  # - label
+  # - milestone
+  # - member
+  # - membership
+  # - org_block
+  # - organization
+  # - page_build
+  # - project
+  # - project_card
+  # - project_column
+  # - public
+  - pull_request
+# - pull_request_review
+# - pull_request_review_comment
+# - push
+# - release
+# - repository
+# - repository_import
+# - status
+# - team
+# - team_add
+# - watch
+
+# The set of permissions needed by the GitHub App. The format of the object uses
+# the permission name for the key (for example, issues) and the access type for
+# the value (for example, write).
+# Valid values are `read`, `write`, and `none`
+default_permissions:
+  # Repository creation, deletion, settings, teams, and collaborators.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-administration
+  # administration: read
+
+  # Checks on code.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-checks
+  # checks: read
+
+  # Repository contents, commits, branches, downloads, releases, and merges.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-contents
+  contents: read
+
+  # Deployments and deployment statuses.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-deployments
+  # deployments: read
+
+  # Issues and related comments, assignees, labels, and milestones.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-issues
+  # issues: write
+
+  # Search repositories, list collaborators, and access repository metadata.
+  # https://developer.github.com/v3/apps/permissions/#metadata-permissions
+  metadata: read
+
+  # Retrieve Pages statuses, configuration, and builds, as well as create new builds.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-pages
+  # pages: read
+
+  # Pull requests and related comments, assignees, labels, milestones, and merges.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-pull-requests
+  pull_requests: write
+
+  # Manage the post-receive hooks for a repository.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-repository-hooks
+  # repository_hooks: read
+
+  # Manage repository projects, columns, and cards.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-repository-projects
+  # repository_projects: read
+
+  # Retrieve security vulnerability alerts.
+  # https://developer.github.com/v4/object/repositoryvulnerabilityalert/
+  # vulnerability_alerts: read
+
+  # Commit statuses.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-statuses
+  # statuses: read
+
+  # Organization members and teams.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-members
+  # members: read
+
+  # View and manage users blocked by the organization.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-organization-user-blocking
+  # organization_user_blocking: read
+
+  # Manage organization projects, columns, and cards.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-organization-projects
+  # organization_projects: read
+
+  # Manage team discussions and related comments.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-team-discussions
+  # team_discussions: read
+
+  # Manage the post-receive hooks for an organization.
+  # https://developer.github.com/v3/apps/permissions/#permission-on-organization-hooks
+  # organization_hooks: read
+
+  # Get notified of, and update, content references.
+  # https://developer.github.com/v3/apps/permissions/
+  # organization_administration: read
+# The name of the GitHub App. Defaults to the name specified in package.json
+# name: My Probot App
+
+# The homepage of your GitHub App.
+# url: https://example.com/
+
+# A description of the GitHub App.
+# description: A description of my awesome app
+
+# Set to true when your GitHub App is available to the public or false when it is only accessible to the owner of the app.
+# Default: true
+# public: false

package/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  roots: ["<rootDir>/src/"],
+  transform: {
+    "^.+\\.tsx?$": "ts-jest",
+  },
+  testRegex: "(/__tests__/.*|\\.(test|spec))\\.[tj]sx?$",
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  testEnvironment: "node",
+};

package/lib/netlify/functions/snowflake.d.ts

@@ -0,0 +1,2 @@
+declare const handler: (event: import("aws-lambda").APIGatewayProxyEvent, context: import("aws-lambda").Context) => Promise<import("aws-lambda").APIGatewayProxyResult>;
+export { handler };

package/lib/netlify/functions/snowflake.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = void 0;
+const adapter_aws_lambda_serverless_1 = require("@probot/adapter-aws-lambda-serverless");
+const index_1 = __importDefault(require("../../src/index"));
+const handler = (0, adapter_aws_lambda_serverless_1.createLambdaFunction)(index_1.default, { probot: (0, adapter_aws_lambda_serverless_1.createProbot)() });
+exports.handler = handler;

package/lib/src/__mocks__/sourceSample.d.ts

@@ -0,0 +1,2 @@
+declare const Sample: () => void;
+export default Sample;

package/lib/src/__mocks__/sourceSample.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const react_2 = require("@hero-design/react");
+const styled_components_1 = __importDefault(require("styled-components"));
+// Snowflakes using styled-components;
+const StyledButton = (0, styled_components_1.default)(react_2.Button) `
+  padding: 10px;
+`;
+const StyledLinkButton = (0, styled_components_1.default)(react_2.Button.Link) `
+  color: red;
+`;
+const { Link } = react_2.Button;
+const StyledLink = (0, styled_components_1.default)(Link) `
+  color: red;
+`;
+const Sample = () => {
+    <>
+    <StyledButton />
+    <StyledLinkButton />
+    <StyledLink />
+  </>;
+};
+exports.default = Sample;

package/lib/src/__tests__/parseSource.spec.d.ts

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

package/lib/src/__tests__/parseSource.spec.js

@@ -0,0 +1,41 @@
+"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 fs = __importStar(require("fs"));
+const parseSource_1 = __importDefault(require("../parseSource"));
+describe('parseSource', () => {
+    it('reports correct snowflakes', () => {
+        const source = fs.readFileSync('./src/__mocks__/sourceSample.tsx', 'utf-8');
+        expect((0, parseSource_1.default)(source)).toEqual({
+            classNameLocs: [44, 42, 43],
+            styleLocs: [54, 47, 49, 50, 51, 52, 53],
+            sxLocs: [63, 58, 59, 60, 61, 62],
+            styledComponentLocs: [6, 10, 15],
+        });
+    });
+});

package/lib/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Probot } from 'probot';
+declare const _default: (app: Probot) => void;
+export = _default;

package/lib/src/index.js

@@ -0,0 +1,142 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const probot_1 = require("probot");
+const parseSource_1 = __importDefault(require("./parseSource"));
+const TSX_REGEX = /\.tsx$/;
+const TEST_REGEX = /__tests__/;
+const DIFF_LOCS_REGEX = /@@(.*)@@/g;
+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).',
+    sx: 'Snowflake detected! A component is customized via sx prop. Make sure to not use [prohibited CSS properties](https://docs.google.com/spreadsheets/d/1Dj8vqLdFaf-CSaSVoYqyYZIkGqF6OoyP7K4G1_9L62U/edit?usp=sharing).',
+    '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.',
+};
+const getDiffLocs = (diffStrs) => {
+    const locs = [];
+    diffStrs.forEach((diffStr) => {
+        const [startLocStr, numberOfLinesStr] = diffStr
+            .split('+')[1]
+            .split(' ')[0]
+            .split(',');
+        const startLoc = Number(startLocStr);
+        const numberOfLines = Number(numberOfLinesStr);
+        locs.push([startLoc, numberOfLines]);
+    });
+    return locs;
+};
+const checkIfDetectedSnowflakesInDiff = (diffLocs, locToComment) => {
+    const locIdx = diffLocs.findIndex(([start, numberOfLines]) => {
+        return locToComment >= start && locToComment < start + numberOfLines;
+    });
+    return locIdx !== -1;
+};
+module.exports = (app) => {
+    app.on(['pull_request.opened', 'pull_request.synchronize'], (context) => __awaiter(void 0, void 0, void 0, function* () {
+        // Get PR info
+        const prNumber = context.payload.number;
+        const repoInfo = {
+            repo: context.payload.repository.name,
+            owner: context.payload.repository.owner.login,
+        };
+        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 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 = tsxFiles.reduce((acc, file) => {
+            acc[file.filename] = file.patch || '';
+            return acc;
+        }, {});
+        // Get file contents
+        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 styleComments = [];
+        const sxComments = [];
+        const styledComponentComments = [];
+        const classNameComments = [];
+        prFileContents.forEach((file) => __awaiter(void 0, void 0, void 0, function* () {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            const filePath = file.data.path;
+            const diffLocs = getDiffLocs(prFilePatches[filePath].match(DIFF_LOCS_REGEX) || []);
+            const stringContent = Buffer.from(
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            file.data.content, 'base64').toString();
+            // Parse file content to check for snowflakes
+            const snowflakeReport = (0, parseSource_1.default)(stringContent);
+            snowflakeReport.styleLocs.forEach((loc) => {
+                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
+                    styleComments.push({
+                        path: filePath,
+                        body: SNOWFLAKE_COMMENTS['style'],
+                        line: loc,
+                    });
+                }
+            });
+            snowflakeReport.sxLocs.forEach((loc) => {
+                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
+                    sxComments.push({
+                        path: filePath,
+                        body: SNOWFLAKE_COMMENTS['sx'],
+                        line: loc,
+                    });
+                }
+            });
+            snowflakeReport.styledComponentLocs.forEach((loc) => {
+                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
+                    styledComponentComments.push({
+                        path: filePath,
+                        body: SNOWFLAKE_COMMENTS['styled-component'],
+                        line: loc,
+                    });
+                }
+            });
+            snowflakeReport.classNameLocs.forEach((loc) => {
+                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
+                    classNameComments.push({
+                        path: filePath,
+                        body: SNOWFLAKE_COMMENTS['className'],
+                        line: loc,
+                    });
+                }
+            });
+        }));
+        const personalOctokit = new probot_1.ProbotOctokit({
+            auth: { token: process.env.EH_BOT_GITHUB_TOKEN },
+        });
+        // No snowflakes detected or only potential snowflakes using classname
+        if (styleComments.length === 0 &&
+            sxComments.length === 0 &&
+            styledComponentComments.length === 0) {
+            const reviewBody = classNameComments.length > 0
+                ? {
+                    body: '[WARNING] Potential snowflakes detected in this PR using classnames. Please review the following comments.',
+                    comments: classNameComments,
+                }
+                : {
+                    body: 'No snowflakes detected in this PR.',
+                };
+            return personalOctokit.pulls.createReview(Object.assign(Object.assign(Object.assign({}, repoInfo), { pull_number: prNumber, commit_id: context.payload.pull_request.head.sha, event: 'APPROVE' }), reviewBody));
+        }
+        return personalOctokit.pulls.createReview(Object.assign(Object.assign({}, repoInfo), { pull_number: prNumber, commit_id: context.payload.pull_request.head.sha, event: 'REQUEST_CHANGES', body: 'Snowflake Guard Bot has detected some snowflakes in this PR. Please review the following comments.', comments: [
+                ...styleComments,
+                ...sxComments,
+                ...styledComponentComments,
+                ...classNameComments,
+            ] }));
+    }));
+};

package/lib/src/parseSource.d.ts

@@ -0,0 +1,7 @@
+declare const parseSource: (source: string) => {
+    classNameLocs: number[];
+    styleLocs: number[];
+    sxLocs: number[];
+    styledComponentLocs: number[];
+};
+export default parseSource;

package/lib/src/parseSource.js

@@ -0,0 +1,102 @@
+"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 tsParser = __importStar(require("./parsers/typescript"));
+const reportCustomStyleProperties_1 = __importDefault(require("./reports/reportCustomStyleProperties"));
+const reportStyledComponents_1 = __importDefault(require("./reports/reportStyledComponents"));
+const constants_1 = require("./reports/constants");
+const parseSource = (source) => {
+    let hasHeroDesignImport = false;
+    let hasStyledComponentsImport = false;
+    const componentList = {};
+    let styledAliasName = 'styled';
+    let styledComponentLocs = [];
+    let classNameLocs = [];
+    let styleLocs = [];
+    let sxLocs = [];
+    const approvedCmtLocs = [];
+    const ast = recast.parse(source, { parser: tsParser });
+    recast.visit(ast, {
+        visitImportDeclaration(path) {
+            this.traverse(path);
+            const importedFrom = path.value.source.value;
+            // Check if file imports components from '@hero-design/react'
+            if (importedFrom === '@hero-design/react') {
+                recast.visit(path.node, {
+                    visitImportSpecifier(importPath) {
+                        this.traverse(importPath);
+                        if (constants_1.HD_COMPONENTS.includes(importPath.value.imported.name)) {
+                            componentList[importPath.value.local.name] =
+                                importPath.value.imported.name;
+                            hasHeroDesignImport = true;
+                        }
+                    },
+                });
+            }
+            // Check if file imports from 'styled-components'
+            if (importedFrom === 'styled-components') {
+                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_1.APPROVED_COMMENT.toLowerCase())) {
+                approvedCmtLocs.push(path.value.loc.start.line);
+            }
+        },
+    });
+    const isNotApprovedSnowflakes = (loc) => !approvedCmtLocs.includes(loc);
+    if (hasHeroDesignImport) {
+        // Case 1: Using className to customise components
+        // Case 2: Using style object to customise components
+        // Case 3: Using sx object to customise components
+        const customPropLocs = (0, reportCustomStyleProperties_1.default)(ast, componentList);
+        classNameLocs = customPropLocs.className.filter(isNotApprovedSnowflakes);
+        styleLocs = customPropLocs.style.filter(isNotApprovedSnowflakes);
+        sxLocs = customPropLocs.sx.filter(isNotApprovedSnowflakes);
+        // Case 4: Using styled-components to customise components
+        if (hasStyledComponentsImport) {
+            styledComponentLocs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName).filter(isNotApprovedSnowflakes);
+        }
+    }
+    return {
+        classNameLocs,
+        styleLocs,
+        sxLocs,
+        styledComponentLocs,
+    };
+};
+exports.default = parseSource;

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

@@ -0,0 +1,3 @@
+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>;