@hero-design/snowflake-guard 1.3.3 → 1.3.5

package/lib/src/index.js

@@ -20,13 +20,18 @@ const getDiffLocs_1 = require("./utils/getDiffLocs");
 const WEB_REGEX = /\.tsx$/;
 const MOBILE_REGEX = /\.(tsx|jsx|js)$/;
 const TEST_REGEX = /__tests__/;
-const SNOWFLAKE_COMMENTS = {
+const SNOWFLAKE_COMMENTS_WEB = {
     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. In case this is none-css classname, please flag it with this comment \`${constants_1.APPROVED_CLASSNAME_COMMENT}\`.`,
 };
+const SNOWFLAKE_COMMENTS_MOBILE = {
+    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?gid=1761479144#gid=1761479144).',
+    'styled-component': 'Please do not use styled-component to customize this component.',
+};
 const MOBILE_REPO_NAMES = JSON.parse(process.env.MOBILE_REPO_NAMES || '[]');
+const APPROVED_USER_LIST = JSON.parse(process.env.APPROVED_USER_LIST || '[]');
 const checkIfDetectedSnowflakesInDiff = (diffLocs, locToComment) => {
     const locIdx = diffLocs.findIndex(([start, end]) => {
         return locToComment >= start && locToComment <= end;
@@ -76,7 +81,9 @@ module.exports = (app) => {
                 if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                     snowflakeComments.push({
                         path: filePath,
-                        body: SNOWFLAKE_COMMENTS['style'],
+                        body: isMobile
+                            ? SNOWFLAKE_COMMENTS_MOBILE['style']
+                            : SNOWFLAKE_COMMENTS_WEB['style'],
                         line: loc,
                     });
                 }
@@ -85,7 +92,9 @@ module.exports = (app) => {
                 if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                     snowflakeComments.push({
                         path: filePath,
-                        body: SNOWFLAKE_COMMENTS['styled-component'],
+                        body: isMobile
+                            ? SNOWFLAKE_COMMENTS_MOBILE['styled-component']
+                            : SNOWFLAKE_COMMENTS_WEB['styled-component'],
                         line: loc,
                     });
                 }
@@ -100,7 +109,7 @@ module.exports = (app) => {
                     if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                         snowflakeComments.push({
                             path: filePath,
-                            body: SNOWFLAKE_COMMENTS['sx'],
+                            body: SNOWFLAKE_COMMENTS_WEB['sx'],
                             line: loc,
                         });
                     }
@@ -109,7 +118,7 @@ module.exports = (app) => {
                     if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
                         snowflakeComments.push({
                             path: filePath,
-                            body: SNOWFLAKE_COMMENTS['className'],
+                            body: SNOWFLAKE_COMMENTS_WEB['className'],
                             line: loc,
                         });
                     }
@@ -147,4 +156,20 @@ module.exports = (app) => {
         yield context.octokit.checks.create(Object.assign(Object.assign({}, repoInfo), { name: 'SnowflakeGuard/Check', head_sha: context.payload.pull_request.head.sha, status: 'completed', conclusion: 'failure' }));
         return context.octokit.pulls.createReview(Object.assign(Object.assign({}, repoInfo), { pull_number: prNumber, commit_id: context.payload.pull_request.head.sha, event: 'COMMENT', body: 'Snowflake Guard Bot has detected some snowflakes in this PR. Please review the following comments.', comments: snowflakeComments }));
     }));
+    app.on('pull_request_review.submitted', (context) => {
+        const submittedType = context.payload.review.state;
+        const submittedUser = context.payload.review.user.login;
+        if (submittedType !== 'approved' ||
+            !APPROVED_USER_LIST.includes(submittedUser)) {
+            return;
+        }
+        return context.octokit.checks.create({
+            repo: context.payload.repository.name,
+            owner: context.payload.repository.owner.login,
+            name: 'SnowflakeGuard/Check',
+            head_sha: context.payload.pull_request.head.sha,
+            status: 'completed',
+            conclusion: 'success',
+        });
+    });
 };

package/package.json

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