@hero-design/snowflake-guard 1.4.10 → 1.4.12

package/lib/src/reports/reportInlineStyle.js

@@ -1,238 +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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const recast = __importStar(require("recast"));
-const constants_1 = require("./constants");
-const BLACKLIST_PROPERTIES = {
-    style: constants_1.RULESET_MAP,
-    sx: constants_1.SX_RULESET_MAP,
-};
-const INLINE_STYLE_PROPERTIES = ['style', 'sx'];
-const ADDITIONAL_PROPERTIES = ['variant']; // Add any additional props you want to track
-const addViolatingAttribute = (prop, styleObjName, componentName, loc, violatingAttributes) => {
-    if (prop.key.type !== 'Identifier') {
-        return;
-    }
-    violatingAttributes.push({
-        attributeName: prop.key.name,
-        attributeValue: recast.print(prop.value).code,
-        inlineStyleProps: styleObjName,
-        componentName,
-        loc,
-    });
-};
-const getPropValue = (attr) => {
-    var _a;
-    if (!attr.value) {
-        return ''; // Handle case where value is missing
-    }
-    if (typeof attr.value === 'string') {
-        return attr.value; // Directly return string value
-    }
-    if (((_a = attr.value) === null || _a === void 0 ? void 0 : _a.type) === 'JSXExpressionContainer') {
-        return recast.print(attr.value.expression).code;
-    }
-    // Use recast to print the expression if it's not a simple string
-    return recast.print(attr.value).code;
-};
-const reportInlineStyle = (ast, attributes, componentName) => {
-    const locs = {};
-    const violatingAttributes = [];
-    const additionalProps = [];
-    let hasCustomStyle = false;
-    let styleObjName;
-    attributes.forEach((attr) => {
-        var _a;
-        if (attr.type !== 'JSXAttribute') {
-            return;
-        }
-        if (typeof attr.name.name !== 'string') {
-            return;
-        }
-        if (ADDITIONAL_PROPERTIES.includes(attr.name.name)) {
-            // Handle expression container like `style={{ ... }}`
-            additionalProps.push({
-                propName: attr.name.name,
-                propValue: getPropValue(attr), // Print expression as string
-            });
-        }
-        if (((_a = attr.value) === null || _a === void 0 ? void 0 : _a.type) !== 'JSXExpressionContainer') {
-            return;
-        }
-        if (INLINE_STYLE_PROPERTIES.includes(attr.name.name)) {
-            styleObjName = attr.name.name;
-            const { expression } = attr.value;
-            if (expression.type === 'ObjectExpression') {
-                expression.properties.forEach((prop) => {
-                    var _a;
-                    // Case 1: Use direct object, e.g. <Card style={{ color: 'red' }} />
-                    if (prop.type === 'ObjectProperty' &&
-                        prop.key.type === 'Identifier' &&
-                        BLACKLIST_PROPERTIES[styleObjName][componentName].includes(prop.key.name)) {
-                        hasCustomStyle = true;
-                        addViolatingAttribute(prop, styleObjName, componentName, (_a = attr.loc) === null || _a === void 0 ? void 0 : _a.start.line, violatingAttributes);
-                    }
-                    // Case 2: Use spread operator, e.g. <Card style={{ ...customStyle }} />
-                    if (prop.type === 'SpreadElement' &&
-                        prop.argument.type === 'Identifier') {
-                        const variableName = prop.argument.name;
-                        recast.visit(ast, {
-                            visitVariableDeclaration(path) {
-                                var _a;
-                                this.traverse(path);
-                                const declaration = path.value
-                                    .declarations[0];
-                                if (declaration.id.type === 'Identifier' &&
-                                    declaration.id.name === variableName &&
-                                    ((_a = declaration.init) === null || _a === void 0 ? void 0 : _a.type) === 'ObjectExpression') {
-                                    declaration.init.properties.forEach((deProp) => {
-                                        var _a;
-                                        if (deProp.type === 'ObjectProperty' &&
-                                            deProp.key.type === 'Identifier' &&
-                                            BLACKLIST_PROPERTIES[styleObjName][componentName].includes(deProp.key.name)) {
-                                            hasCustomStyle = true;
-                                            addViolatingAttribute(deProp, styleObjName, componentName, (_a = attr.loc) === null || _a === void 0 ? void 0 : _a.start.line, violatingAttributes);
-                                        }
-                                    });
-                                }
-                            },
-                        });
-                    }
-                    // Case 3: Use spread operator with variable's property, e.g. <Card style={{ ...customStyle.tileCard }} />
-                    if (prop.type === 'SpreadElement' &&
-                        prop.argument.type === 'MemberExpression' &&
-                        prop.argument.object.type === 'Identifier' &&
-                        prop.argument.property.type === 'Identifier') {
-                        const variableName = prop.argument.object.name;
-                        const propName = prop.argument.property.name;
-                        recast.visit(ast, {
-                            visitVariableDeclaration(path) {
-                                var _a;
-                                this.traverse(path);
-                                const declaration = path.value
-                                    .declarations[0];
-                                if (declaration.id.type === 'Identifier' &&
-                                    declaration.id.name === variableName &&
-                                    ((_a = declaration.init) === null || _a === void 0 ? void 0 : _a.type) === 'ObjectExpression') {
-                                    declaration.init.properties.forEach((deProp) => {
-                                        if (deProp.type === 'ObjectProperty' &&
-                                            deProp.key.type === 'Identifier' &&
-                                            deProp.key.name === propName &&
-                                            deProp.value.type === 'ObjectExpression') {
-                                            deProp.value.properties.forEach((p) => {
-                                                var _a;
-                                                if (p.type === 'ObjectProperty' &&
-                                                    p.key.type === 'Identifier' &&
-                                                    BLACKLIST_PROPERTIES[styleObjName][componentName].includes(p.key.name)) {
-                                                    hasCustomStyle = true;
-                                                    addViolatingAttribute(p, styleObjName, componentName, (_a = attr.loc) === null || _a === void 0 ? void 0 : _a.start.line, violatingAttributes);
-                                                }
-                                            });
-                                        }
-                                    });
-                                }
-                            },
-                        });
-                    }
-                });
-            }
-            // Case 4: Use variable, e.g. <Card style={customStyle} />
-            if (expression.type === 'Identifier') {
-                const variableName = expression.name;
-                recast.visit(ast, {
-                    visitVariableDeclaration(path) {
-                        var _a;
-                        this.traverse(path);
-                        const declaration = path.value
-                            .declarations[0];
-                        if (declaration.id.type === 'Identifier' &&
-                            declaration.id.name === variableName &&
-                            ((_a = declaration.init) === null || _a === void 0 ? void 0 : _a.type) === 'ObjectExpression') {
-                            declaration.init.properties.forEach((prop) => {
-                                var _a;
-                                if (prop.type === 'ObjectProperty' &&
-                                    prop.key.type === 'Identifier' &&
-                                    BLACKLIST_PROPERTIES[styleObjName][componentName].includes(prop.key.name)) {
-                                    hasCustomStyle = true;
-                                    addViolatingAttribute(prop, styleObjName, componentName, (_a = attr.loc) === null || _a === void 0 ? void 0 : _a.start.line, violatingAttributes);
-                                }
-                            });
-                        }
-                    },
-                });
-            }
-            // Case 5: Use variable's property, e.g. <Card style={customStyle.tileCard} />
-            if (expression.type === 'MemberExpression' &&
-                expression.object.type === 'Identifier' &&
-                expression.property.type === 'Identifier') {
-                const objectName = expression.object.name;
-                const propName = expression.property.name;
-                recast.visit(ast, {
-                    visitVariableDeclaration(path) {
-                        var _a;
-                        this.traverse(path);
-                        const declaration = path.value
-                            .declarations[0];
-                        if (declaration.id.type === 'Identifier' &&
-                            declaration.id.name === objectName &&
-                            ((_a = declaration.init) === null || _a === void 0 ? void 0 : _a.type) === 'ObjectExpression') {
-                            declaration.init.properties.forEach((prop) => {
-                                if (prop.type === 'ObjectProperty' &&
-                                    prop.key.type === 'Identifier' &&
-                                    prop.key.name === propName &&
-                                    prop.value.type === 'ObjectExpression') {
-                                    prop.value.properties.forEach((p) => {
-                                        var _a;
-                                        if (p.type === 'ObjectProperty' &&
-                                            p.key.type === 'Identifier' &&
-                                            BLACKLIST_PROPERTIES[styleObjName][componentName].includes(p.key.name)) {
-                                            hasCustomStyle = true;
-                                            addViolatingAttribute(p, styleObjName, componentName, (_a = attr.loc) === null || _a === void 0 ? void 0 : _a.start.line, violatingAttributes);
-                                        }
-                                    });
-                                }
-                            });
-                        }
-                    },
-                });
-            }
-            if (hasCustomStyle && attr.loc) {
-                locs[styleObjName] = attr.loc.start.line;
-            }
-        }
-    });
-    return { locs, violatingAttributes, additionalProps };
-};
-exports.default = reportInlineStyle;

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

@@ -1,6 +0,0 @@
-import * as recast from 'recast';
-import type { ComponentName } from './types';
-declare const reportStyledComponents: (ast: recast.types.ASTNode, componentList: {
-    [k: string]: ComponentName;
-}, styledAliasName: string) => number[];
-export default reportStyledComponents;

package/lib/src/reports/reportStyledComponents.js

@@ -1,105 +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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const recast = __importStar(require("recast"));
-const reportStyledComponents = (ast, componentList, styledAliasName) => {
-    const locs = [];
-    const localComponentList = Object.keys(componentList);
-    recast.visit(ast, {
-        visitVariableDeclaration(path) {
-            this.traverse(path);
-            const declaration = path.value
-                .declarations[0];
-            if (declaration.init &&
-                declaration.init.type === 'TaggedTemplateExpression') {
-                const { tag } = declaration.init;
-                if (tag.type === 'CallExpression' &&
-                    tag.callee.type === 'Identifier' &&
-                    tag.callee.name === styledAliasName) {
-                    const arg = tag.arguments[0];
-                    // Case 1: Custom default component, e.g. styled(Card)
-                    if (arg.type === 'Identifier' &&
-                        localComponentList.includes(arg.name) &&
-                        tag.loc) {
-                        locs.push(tag.loc.start.line);
-                    }
-                    // Case 2: Custom compound component, e.g. styled(Card.Header)
-                    if (arg.type === 'MemberExpression' &&
-                        arg.object.type === 'Identifier' &&
-                        localComponentList.includes(arg.object.name) &&
-                        tag.loc) {
-                        locs.push(tag.loc.start.line);
-                    }
-                }
-            }
-            // Case 3: Custom compound component with spead operator. e.g. const { Header } = Card, then styled(Header)
-            if (declaration.init &&
-                declaration.init.type === 'Identifier' &&
-                localComponentList.includes(declaration.init.name)) {
-                const { id } = declaration;
-                if (id.type === 'ObjectPattern') {
-                    const compoundComponentNames = id.properties
-                        .map((prop) => prop.type === 'ObjectProperty' && prop.key.type === 'Identifier'
-                        ? prop.key.name
-                        : null)
-                        .filter((name) => name !== null);
-                    recast.visit(ast, {
-                        visitVariableDeclaration(spreadPath) {
-                            this.traverse(spreadPath);
-                            const spreadDeclaration = spreadPath.value
-                                .declarations[0];
-                            if (spreadDeclaration.init &&
-                                spreadDeclaration.init.type === 'TaggedTemplateExpression') {
-                                const { tag } = spreadDeclaration.init;
-                                if (tag.type === 'CallExpression' &&
-                                    tag.callee.type === 'Identifier' &&
-                                    tag.callee.name === styledAliasName) {
-                                    const arg = tag.arguments[0];
-                                    if (arg.type === 'Identifier' &&
-                                        compoundComponentNames.includes(arg.name) &&
-                                        tag.loc) {
-                                        locs.push(tag.loc.start.line);
-                                    }
-                                }
-                            }
-                        },
-                    });
-                }
-            }
-        },
-    });
-    return locs;
-};
-exports.default = reportStyledComponents;

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

@@ -1,3 +0,0 @@
-import type { HD_COMPONENTS, RULESET_MAP } from './constants';
-export type ComponentName = typeof HD_COMPONENTS[number];
-export type CompoundComponentName = keyof typeof RULESET_MAP;

package/lib/src/reports/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/utils/__tests__/getDiffLocs.spec.d.ts

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

package/lib/src/utils/__tests__/getDiffLocs.spec.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const getDiffLocs_1 = require("../getDiffLocs");
-describe('getDiffLocs', () => {
-    it('returns diff locations from patches', () => {
-        const filePatch = "@@ -4,8 +4,6 @@ import { Button, Typography, Box, ButtonProps } from '@hero-design/react';\n" +
-            ' \n' +
-            " import emptyBanner from './assets/empty-banner.png';\n" +
-            ' \n' +
-            "-console.log('test');\n" +
-            '-\n' +
-            ' const EmptyImg = styled.img`\n' +
-            '   height: 172px;\n' +
-            `   margin-bottom: \${({ theme }) => theme.space.small}px;\n` +
-            '@@ -28,7 +26,8 @@ const EmptyTableView = ({\n' +
-            '     <EmptyImg src={emptyBanner} alt="Empty" />\n' +
-            '     <Typography.Text\n' +
-            '       fontSize={14}\n' +
-            "-      sx={{ color: 'bodyText', mb: 'xxlarge', whiteSpace: 'pre-wrap' }} // @snowflake-guard/snowflake-approved-by-andromeda\n" +
-            "+      sx={{ color: 'bodyText', mb: 'xxlarge', whiteSpace: 'pre-wrap', backgroundColour: 'lightPrimary' }} // @snowflake-guard/snowflake-approved-by-andromeda\n" +
-            '+      aria-label="Empty table message"\n' +
-            '     >\n' +
-            '       {message}\n' +
-            '     </Typography.Text>\n' +
-            '@@ -39,6 +38,7 @@ const EmptyTableView = ({\n' +
-            '       text={buttonText}\n' +
-            '     />\n' +
-            '   </Box>\n' +
-            '+\n' +
-            ' );\n' +
-            ' \n' +
-            ' export default EmptyTableView;';
-        expect((0, getDiffLocs_1.getDiffLocs)(filePatch)).toEqual([
-            [7, 6],
-            [29, 30],
-            [41, 41],
-        ]);
-    });
-    it('returns empty for empty patches', () => {
-        const filePatch = '';
-        expect((0, getDiffLocs_1.getDiffLocs)(filePatch)).toEqual([]);
-    });
-});

package/lib/src/utils/getDiffLocs.d.ts

@@ -1,3 +0,0 @@
-export type DiffLocs = [number, number][];
-declare const getDiffLocs: (filePatch: string) => DiffLocs;
-export { getDiffLocs };

package/lib/src/utils/getDiffLocs.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDiffLocs = void 0;
-const DIFF_LOCS_REGEX = /@@(.*)@@/g;
-const getDiffLocs = (filePatch) => {
-    const locs = [];
-    const patches = {};
-    if (!filePatch) {
-        return locs;
-    }
-    // Split file patch into lines
-    const splitPatch = filePatch.split('\n');
-    // Get patches
-    // Example: @@ -1,2 +1,3 @@
-    let tempPatch = '';
-    splitPatch.forEach((linePatch) => {
-        const matchPatch = linePatch.match(DIFF_LOCS_REGEX);
-        if (matchPatch) {
-            [tempPatch] = matchPatch[0].split('+')[1].split(' ');
-            patches[tempPatch] = [];
-        }
-        else {
-            patches[tempPatch].push(linePatch);
-        }
-    });
-    // Get diff locations from patches
-    Object.entries(patches).forEach(([loc, lines]) => {
-        const [startLoc, numberOfLines] = loc
-            .split(',')
-            .map((l) => parseInt(l, 10));
-        const endLoc = startLoc + numberOfLines - 1;
-        const firstDiffLineIdx = lines.findIndex((l) => l.startsWith('+') || l.startsWith('-'));
-        const lastDiffLineIdx = lines
-            .reverse()
-            .findIndex((l) => l.startsWith('+') || l.startsWith('-'));
-        locs.push([startLoc + firstDiffLineIdx, endLoc - lastDiffLineIdx]);
-    });
-    return locs;
-};
-exports.getDiffLocs = getDiffLocs;