@hero-design/snowflake-guard 1.4.10 → 1.4.12

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

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

package/lib/src/reports/mobile/__tests__/reportCustomStyleProperties.spec.js

@@ -1,144 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const reportCustomStyleProperties_1 = __importDefault(require("../reportCustomStyleProperties"));
-const testUtils_1 = require("../testUtils");
-const componentList = {
-    Card: 'Card',
-    Button: 'Button',
-};
-const commentList = {
-    styleCmts: [],
-};
-describe('reportCustomStyleProperties', () => {
-    beforeEach(() => {
-        jest.clearAllMocks();
-    });
-    it('should detect component with inline styles', () => {
-        const source = `const styles = {
-        card: {
-          padding: 10,
-        },
-      };
-
-      const App = () => (
-        <Card style={styles.card}><Content/></Card>
-      );
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const result = (0, reportCustomStyleProperties_1.default)(ast, componentList, commentList);
-        expect(result).toEqual({
-            style: [8],
-            barStyle: [],
-            textStyle: [],
-            containerStyle: [],
-            violatingAttributes: [
-                {
-                    attributeName: 'padding',
-                    attributeValue: '10',
-                    componentName: 'Card',
-                    inlineStyleProps: 'style',
-                    loc: 8,
-                },
-            ],
-        });
-    });
-    it('should detect compound component with inline styles', () => {
-        const source = `const App = () => (
-        <Button.Icon style={{ padding: 10 }} />
-      );
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const result = (0, reportCustomStyleProperties_1.default)(ast, componentList, commentList);
-        expect(result).toEqual({
-            style: [2],
-            barStyle: [],
-            textStyle: [],
-            containerStyle: [],
-            violatingAttributes: [
-                {
-                    attributeName: 'padding',
-                    attributeValue: '10',
-                    componentName: 'Button.Icon',
-                    inlineStyleProps: 'style',
-                    loc: 2,
-                },
-            ],
-        });
-    });
-    it('should detect compound component using spread operator with inline styles', () => {
-        const source = `const { Icon } = Button;
-      const App = () => (
-        <Icon style={{ padding: 10 }} />
-      );
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const result = (0, reportCustomStyleProperties_1.default)(ast, componentList, commentList);
-        expect(result).toEqual({
-            style: [3],
-            barStyle: [],
-            textStyle: [],
-            containerStyle: [],
-            violatingAttributes: [
-                {
-                    attributeName: 'padding',
-                    attributeValue: '10',
-                    componentName: 'Button.Icon',
-                    inlineStyleProps: 'style',
-                    loc: 3,
-                },
-            ],
-        });
-    });
-    it('should not detect non-custom style properties', () => {
-        const source = `
-      const App = () => (
-        <Card><Content/></Card>
-      );
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const result = (0, reportCustomStyleProperties_1.default)(ast, componentList, commentList);
-        expect(result).toEqual({
-            style: [],
-            barStyle: [],
-            textStyle: [],
-            containerStyle: [],
-            violatingAttributes: [],
-        });
-    });
-    it('should ignore approved inline styles', () => {
-        const mockedCommentList = {
-            styleCmts: [
-                {
-                    loc: 10,
-                    comment: '@snowflake-guard/approved-inline-style attributes: padding',
-                },
-            ],
-        };
-        const source = `
-      const styles = {
-        button: {
-          padding: 10,
-        },
-      };
-
-      const App = () => (
-      <> 
-        {/* @snowflake-guard/approved-inline-style attributes: padding */}
-        <Button style={styles.button} />
-      </>
-      );
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const result = (0, reportCustomStyleProperties_1.default)(ast, componentList, mockedCommentList);
-        expect(result).toEqual({
-            style: [],
-            barStyle: [],
-            textStyle: [],
-            containerStyle: [],
-            violatingAttributes: [],
-        });
-    });
-});

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

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

package/lib/src/reports/mobile/__tests__/reportInlineStyle.spec.js

@@ -1,113 +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;
-    };
-})();
-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 reportInlineStyle_1 = __importDefault(require("../reportInlineStyle"));
-const constants_1 = require("../constants");
-const tsParser = __importStar(require("../../../parsers/typescript"));
-describe('reportInlineStyle', () => {
-    it('should return line numbers and violating attributes for inline styles that violate the ruleset', () => {
-        const code = `
-    const MyComponent = () => (
-      <Card style={{
-              color: 'red',
-              backgroundColor: 'blue'
-            }}
-/>
-    );
-  `;
-        // Step 1: Parse the code to generate the AST
-        const ast = recast.parse(code, { parser: tsParser });
-        const attributes = [];
-        // Step 2: Traverse the AST to extract relevant JSXAttributes (style)
-        recast.visit(ast, {
-            visitJSXAttribute(path) {
-                const { node } = path;
-                attributes.push(node);
-                this.traverse(path);
-            },
-        });
-        const componentName = 'Card';
-        // Mock the RULESET_MAP for this test
-        constants_1.MOBILE_RULESET_MAP.Card = ['color', 'backgroundColor'];
-        // Step 3: Run the function with the dynamically extracted attributes
-        const result = (0, reportInlineStyle_1.default)(ast, attributes, componentName);
-        expect(result.locs.style).toEqual(3);
-        expect(result.violatingAttributes).toEqual([
-            {
-                attributeName: 'color',
-                attributeValue: "'red'",
-                componentName: 'Card',
-                inlineStyleProps: 'style',
-                loc: 3,
-            },
-            {
-                attributeName: 'backgroundColor',
-                attributeValue: "'blue'",
-                componentName: 'Card',
-                inlineStyleProps: 'style',
-                loc: 3,
-            },
-        ]);
-    });
-    it('should return empty arrays when no violations are found', () => {
-        const code = `
-      const MyComponent = () => (
-        <Card style={{ margin: 10 }} />
-      );
-    `;
-        // Step 1: Parse the code to generate the AST
-        const ast = recast.parse(code, { parser: tsParser });
-        const attributes = [];
-        // Step 2: Traverse the AST to extract relevant JSXAttributes (style)
-        recast.visit(ast, {
-            visitJSXAttribute(path) {
-                const { node } = path;
-                attributes.push(node);
-                this.traverse(path);
-            },
-        });
-        const componentName = 'Card';
-        // Mock the RULESET_MAP and SX_RULESET_MAP for this test
-        constants_1.MOBILE_RULESET_MAP.Card = ['color'];
-        const result = (0, reportInlineStyle_1.default)(ast, attributes, componentName);
-        expect(result.locs.style).toEqual(undefined);
-        expect(result.violatingAttributes).toEqual([]);
-        expect(result.violatingAttributes).toEqual([]);
-    });
-});

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

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

package/lib/src/reports/mobile/__tests__/reportStyledComponents.spec.js

@@ -1,54 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const reportStyledComponents_1 = __importDefault(require("../reportStyledComponents"));
-const testUtils_1 = require("../testUtils");
-const componentList = {
-    Button: 'Button',
-    Alert: 'Alert',
-};
-const styledAliasName = 'styled';
-describe('reportStyledComponents', () => {
-    it('should detect styled components with default component', () => {
-        const source = `
-      const StyledCard = styled(Button)\`
-        padding: 10px;
-      \`;
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const locs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName);
-        expect(locs).toEqual([2]);
-    });
-    it('should detect styled components with compound component', () => {
-        const source = `
-      const StyledCardIcon = styled(Button.Icon)\`
-        padding: 10px;
-      \`;
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const locs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName);
-        expect(locs).toEqual([2]);
-    });
-    it('should detect styled components with spread operator', () => {
-        const source = `
-      const { Icon } = Button;
-      const StyledIcon = styled(Icon)\`
-        color: red;
-      \`;
-      <StyledIcon />;
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const locs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName);
-        expect(locs).toEqual([3]);
-    });
-    it('should not detect non-styled components', () => {
-        const source = `
-      const NotStyled = Button;
-    `;
-        const ast = (0, testUtils_1.parseTypeScript)(source);
-        const locs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName);
-        expect(locs).toEqual([]);
-    });
-});

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

@@ -1,106 +0,0 @@
-declare const HD_MOBILE_COMPONENTS: readonly ["Accordion", "Alert", "Attachment", "Avatar", "Badge", "BottomNavigation", "BottomSheet", "Box", "Button", "Calendar", "Carousel", "Card", "Chart", "Chip", "Collapse", "Checkbox", "ContentNavigator", "DatePicker", "Divider", "Drawer", "Empty", "Error", "FAB", "FormGroup", "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", "FilterTrigger", "SegmentedControl"];
-declare const MOBILE_RULESET_MAP: {
-    Accordion: string[];
-    Alert: (string | string[])[];
-    Attachment: string[];
-    Avatar: string[];
-    'Avatar.Stack': string[];
-    Badge: string[];
-    'Badge.Status': string[];
-    BottomNavigation: string[];
-    BottomSheet: string[];
-    'BottomSheet.ScrollView': string[];
-    Box: string[];
-    Button: string[];
-    'Button.Icon': string[];
-    'Button.Utility': string[];
-    Calendar: string[];
-    Card: string[];
-    'Card.Data': string[];
-    Carousel: string[];
-    'Carousel.Card': string[];
-    Checkbox: string[];
-    Chip: string[];
-    'Chart.Column': string[];
-    'Chart.Line': string[];
-    'Chart.SelectAction': string[];
-    Collapse: string[];
-    ContentNavigator: string[];
-    DatePicker: string[];
-    Divider: string[];
-    Drawer: string[];
-    'Drawer.Dragable': string[];
-    Empty: string[];
-    Error: string[];
-    FAB: string[];
-    'FAB.ActionGroup': string[];
-    'FAB.Pair': string[];
-    FloatingIsland: string[];
-    FilterTrigger: string[];
-    Icon: string[];
-    Illustration: string[];
-    Image: string[];
-    'List.BasicItem': string[];
-    'List.Item': string[];
-    MapPin: string[];
-    PageControl: string[];
-    PinInput: string[];
-    Portal: string[];
-    'Progress.Bar': string[];
-    'Progress.Circle': string[];
-    'Progress.Step': string[];
-    'Radio.Group': string[];
-    Rate: string[];
-    RefreshControl: string[];
-    RichTextEditor: string[];
-    'RichTextEditor.MentionList': string[];
-    'RichTextEditor.Toolbar': string[];
-    ScrollViewWithFAB: string[];
-    FlatListWithFAB: string[];
-    SectionListWithFAB: string[];
-    'Search.OneLine': string[];
-    'Search.TwoLine': string[];
-    'Search.SuffixIcon': string[];
-    SectionHeading: string[];
-    Select: string[];
-    'Select.Multi': string[];
-    Skeleton: string[];
-    Slider: string[];
-    Spinner: string[];
-    Success: string[];
-    Swipeable: string[];
-    'Swipeable.Action': string[];
-    'Swipeable.Content': string[];
-    Switch: string[];
-    'Switch.Selector': string[];
-    Tabs: string[];
-    'Tabs.Scroll': string[];
-    Tag: string[];
-    TextInput: string[];
-    FormGroup: string[];
-    SegmentedControl: string[];
-    TimePicker: string[];
-    'Toast.Container': string[];
-    'Toast.Provider': string[];
-    'Toolbar.Group': string[];
-    'Toolbar.Item': string[];
-    'Toolbar.Message': string[];
-    'Typography.Title': string[];
-    'Typography.Body': string[];
-    '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': string[];
-    TextInput: string[];
-    'Search.OneLine': string[];
-};
-export { HD_MOBILE_COMPONENTS, MOBILE_RULESET_MAP, BAR_STYLE_RULESET_MAP, CONTAINER_STYLE_RULESET_MAP, TEXT_STYLE_RULESET_MAP, };