@gallop.software/canon 2.15.0 → 2.15.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli/index.js
CHANGED
|
File without changes
|
|
@@ -2,12 +2,12 @@ const rule = {
|
|
|
2
2
|
meta: {
|
|
3
3
|
type: 'suggestion',
|
|
4
4
|
docs: {
|
|
5
|
-
description: 'Prevent
|
|
5
|
+
description: 'Prevent exporting component functions from block files - reusable components should be in the components folder',
|
|
6
6
|
category: 'Best Practices',
|
|
7
7
|
recommended: true,
|
|
8
8
|
},
|
|
9
9
|
messages: {
|
|
10
|
-
noComponentInBlocks: '[Canon 025]
|
|
10
|
+
noComponentInBlocks: '[Canon 025] Exported component functions should not be defined in block files. Move this component to src/components/ and import it. Non-exported content components are allowed.',
|
|
11
11
|
},
|
|
12
12
|
schema: [],
|
|
13
13
|
},
|
|
@@ -20,6 +20,8 @@ const rule = {
|
|
|
20
20
|
}
|
|
21
21
|
// Track the default export name to allow it
|
|
22
22
|
let defaultExportName = null;
|
|
23
|
+
// Track named exports
|
|
24
|
+
const namedExports = new Set();
|
|
23
25
|
return {
|
|
24
26
|
// Track the default export
|
|
25
27
|
ExportDefaultDeclaration(node) {
|
|
@@ -30,6 +32,34 @@ const rule = {
|
|
|
30
32
|
defaultExportName = node.declaration.name;
|
|
31
33
|
}
|
|
32
34
|
},
|
|
35
|
+
// Track named exports: export function Foo() {} or export const Foo = () => {}
|
|
36
|
+
ExportNamedDeclaration(node) {
|
|
37
|
+
if (node.declaration) {
|
|
38
|
+
if (node.declaration.type === 'FunctionDeclaration' && node.declaration.id) {
|
|
39
|
+
namedExports.add(node.declaration.id.name);
|
|
40
|
+
}
|
|
41
|
+
else if (node.declaration.type === 'VariableDeclaration') {
|
|
42
|
+
for (const declarator of node.declaration.declarations) {
|
|
43
|
+
if (declarator.id.type === 'Identifier') {
|
|
44
|
+
namedExports.add(declarator.id.name);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
// Handle: export { Foo, Bar }
|
|
50
|
+
if (node.specifiers) {
|
|
51
|
+
for (const specifier of node.specifiers) {
|
|
52
|
+
if (specifier.exported.type === 'Identifier') {
|
|
53
|
+
namedExports.add(specifier.exported.name);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
// Check for exported function declarations that look like components (PascalCase)
|
|
59
|
+
'Program:exit'() {
|
|
60
|
+
// Now check all named exports that are PascalCase
|
|
61
|
+
// The actual flagging happens in the ExportNamedDeclaration handler
|
|
62
|
+
},
|
|
33
63
|
// Check for function declarations that look like components (PascalCase)
|
|
34
64
|
FunctionDeclaration(node) {
|
|
35
65
|
if (!node.id)
|
|
@@ -38,6 +68,10 @@ const rule = {
|
|
|
38
68
|
// Skip the default export (the block itself)
|
|
39
69
|
if (name === defaultExportName)
|
|
40
70
|
return;
|
|
71
|
+
// Only flag if it's exported (named export)
|
|
72
|
+
// Non-exported content components are allowed
|
|
73
|
+
if (!namedExports.has(name))
|
|
74
|
+
return;
|
|
41
75
|
// Check if it's PascalCase (likely a component)
|
|
42
76
|
if (/^[A-Z]/.test(name)) {
|
|
43
77
|
context.report({
|
|
@@ -57,6 +91,10 @@ const rule = {
|
|
|
57
91
|
// Skip the default export
|
|
58
92
|
if (name === defaultExportName)
|
|
59
93
|
return;
|
|
94
|
+
// Only flag if it's exported (named export)
|
|
95
|
+
// Non-exported content components are allowed
|
|
96
|
+
if (!namedExports.has(name))
|
|
97
|
+
return;
|
|
60
98
|
// Check if it's PascalCase (likely a component)
|
|
61
99
|
if (/^[A-Z]/.test(name)) {
|
|
62
100
|
context.report({
|
|
@@ -71,4 +109,4 @@ const rule = {
|
|
|
71
109
|
},
|
|
72
110
|
};
|
|
73
111
|
export default rule;
|
|
74
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
112
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"no-component-in-blocks.js","sourceRoot":"","sources":["../../../src/eslint/rules/no-component-in-blocks.ts"],"names":[],"mappings":"AAEA,MAAM,IAAI,GAAoB;IAC5B,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,iHAAiH;YACnH,QAAQ,EAAE,gBAAgB;YAC1B,WAAW,EAAE,IAAI;SAClB;QACD,QAAQ,EAAE;YACR,mBAAmB,EACjB,mLAAmL;SACtL;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAyB;QAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE,CAAA;QAE1D,yBAAyB;QACzB,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;QAChF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,EAAE,CAAA;QACX,CAAC;QAED,4CAA4C;QAC5C,IAAI,iBAAiB,GAAkB,IAAI,CAAA;QAC3C,sBAAsB;QACtB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAA;QAEtC,OAAO;YACL,2BAA2B;YAC3B,wBAAwB,CAAC,IAAI;gBAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,qBAAqB,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;oBAC3E,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAA;gBAC9C,CAAC;qBAAM,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;oBAClD,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;gBAC3C,CAAC;YACH,CAAC;YAED,+EAA+E;YAC/E,sBAAsB,CAAC,IAAI;gBACzB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACrB,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,qBAAqB,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;wBAC3E,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;oBAC5C,CAAC;yBAAM,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;wBAC3D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;4BACvD,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gCACxC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;4BACtC,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,8BAA8B;gBAC9B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACpB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;wBACxC,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;4BAC7C,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;wBAC3C,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,kFAAkF;YAClF,cAAc;gBACZ,kDAAkD;gBAClD,oEAAoE;YACtE,CAAC;YAED,yEAAyE;YACzE,mBAAmB,CAAC,IAAI;gBACtB,IAAI,CAAC,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEpB,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAA;gBAEzB,6CAA6C;gBAC7C,IAAI,IAAI,KAAK,iBAAiB;oBAAE,OAAM;gBAEtC,4CAA4C;gBAC5C,8CAA8C;gBAC9C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;oBAAE,OAAM;gBAEnC,gDAAgD;gBAChD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI;wBACJ,SAAS,EAAE,qBAAqB;qBACjC,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;YAED,oEAAoE;YACpE,mBAAmB,CAAC,IAAI;gBACtB,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBAC3C,IACE,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY;wBACnC,UAAU,CAAC,IAAI;wBACf,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,yBAAyB;4BACjD,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,oBAAoB,CAAC,EAChD,CAAC;wBACD,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI,CAAA;wBAE/B,0BAA0B;wBAC1B,IAAI,IAAI,KAAK,iBAAiB;4BAAE,OAAM;wBAEtC,4CAA4C;wBAC5C,8CAA8C;wBAC9C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;4BAAE,OAAM;wBAEnC,gDAAgD;wBAChD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;4BACxB,OAAO,CAAC,MAAM,CAAC;gCACb,IAAI,EAAE,UAAU;gCAChB,SAAS,EAAE,qBAAqB;6BACjC,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAA;AAED,eAAe,IAAI,CAAA","sourcesContent":["import { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    docs: {\n      description:\n        'Prevent exporting component functions from block files - reusable components should be in the components folder',\n      category: 'Best Practices',\n      recommended: true,\n    },\n    messages: {\n      noComponentInBlocks:\n        '[Canon 025] Exported component functions should not be defined in block files. Move this component to src/components/ and import it. Non-exported content components are allowed.',\n    },\n    schema: [],\n  },\n  create(context: Rule.RuleContext) {\n    const filename = context.filename || context.getFilename()\n\n    // Only check block files\n    const isBlock = filename.includes('/blocks/') || filename.includes('\\\\blocks\\\\')\n    if (!isBlock) {\n      return {}\n    }\n\n    // Track the default export name to allow it\n    let defaultExportName: string | null = null\n    // Track named exports\n    const namedExports = new Set<string>()\n\n    return {\n      // Track the default export\n      ExportDefaultDeclaration(node) {\n        if (node.declaration.type === 'FunctionDeclaration' && node.declaration.id) {\n          defaultExportName = node.declaration.id.name\n        } else if (node.declaration.type === 'Identifier') {\n          defaultExportName = node.declaration.name\n        }\n      },\n\n      // Track named exports: export function Foo() {} or export const Foo = () => {}\n      ExportNamedDeclaration(node) {\n        if (node.declaration) {\n          if (node.declaration.type === 'FunctionDeclaration' && node.declaration.id) {\n            namedExports.add(node.declaration.id.name)\n          } else if (node.declaration.type === 'VariableDeclaration') {\n            for (const declarator of node.declaration.declarations) {\n              if (declarator.id.type === 'Identifier') {\n                namedExports.add(declarator.id.name)\n              }\n            }\n          }\n        }\n        // Handle: export { Foo, Bar }\n        if (node.specifiers) {\n          for (const specifier of node.specifiers) {\n            if (specifier.exported.type === 'Identifier') {\n              namedExports.add(specifier.exported.name)\n            }\n          }\n        }\n      },\n\n      // Check for exported function declarations that look like components (PascalCase)\n      'Program:exit'() {\n        // Now check all named exports that are PascalCase\n        // The actual flagging happens in the ExportNamedDeclaration handler\n      },\n\n      // Check for function declarations that look like components (PascalCase)\n      FunctionDeclaration(node) {\n        if (!node.id) return\n\n        const name = node.id.name\n\n        // Skip the default export (the block itself)\n        if (name === defaultExportName) return\n\n        // Only flag if it's exported (named export)\n        // Non-exported content components are allowed\n        if (!namedExports.has(name)) return\n\n        // Check if it's PascalCase (likely a component)\n        if (/^[A-Z]/.test(name)) {\n          context.report({\n            node,\n            messageId: 'noComponentInBlocks',\n          })\n        }\n      },\n\n      // Check for arrow function components: const MyComponent = () => {}\n      VariableDeclaration(node) {\n        for (const declarator of node.declarations) {\n          if (\n            declarator.id.type === 'Identifier' &&\n            declarator.init &&\n            (declarator.init.type === 'ArrowFunctionExpression' ||\n              declarator.init.type === 'FunctionExpression')\n          ) {\n            const name = declarator.id.name\n\n            // Skip the default export\n            if (name === defaultExportName) return\n\n            // Only flag if it's exported (named export)\n            // Non-exported content components are allowed\n            if (!namedExports.has(name)) return\n\n            // Check if it's PascalCase (likely a component)\n            if (/^[A-Z]/.test(name)) {\n              context.report({\n                node: declarator,\n                messageId: 'noComponentInBlocks',\n              })\n            }\n          }\n        }\n      },\n    }\n  },\n}\n\nexport default rule\n"]}
|
package/package.json
CHANGED
|
@@ -24,6 +24,7 @@ Use dedicated props instead of `className` for styling that components support.
|
|
|
24
24
|
<Heading className="text-center mb-6 text-accent">Title</Heading>
|
|
25
25
|
<Paragraph className="text-lg mb-4">Text content</Paragraph>
|
|
26
26
|
<Label className="text-sm font-semibold">Category</Label>
|
|
27
|
+
<Image src="/photo.jpg" className="rounded-lg aspect-4/5" />
|
|
27
28
|
```
|
|
28
29
|
|
|
29
30
|
### Good
|
|
@@ -38,6 +39,7 @@ Use dedicated props instead of `className` for styling that components support.
|
|
|
38
39
|
<Label fontSize="text-sm" fontWeight="font-semibold">
|
|
39
40
|
Category
|
|
40
41
|
</Label>
|
|
42
|
+
<Image src="/photo.jpg" rounded="rounded-lg" aspect="aspect-4/5" />
|
|
41
43
|
```
|
|
42
44
|
|
|
43
45
|
## Supported Props by Component
|
|
@@ -71,6 +73,10 @@ Use dedicated props instead of `className` for styling that components support.
|
|
|
71
73
|
### Button
|
|
72
74
|
- `margin` — Bottom margin
|
|
73
75
|
|
|
76
|
+
### Image
|
|
77
|
+
- `rounded` — Border radius (e.g., `rounded-lg`, `rounded-none`, `rounded-full`)
|
|
78
|
+
- `aspect` — Aspect ratio (e.g., `aspect-4/5`, `aspect-square`, `aspect-video`)
|
|
79
|
+
|
|
74
80
|
## When to Use className
|
|
75
81
|
|
|
76
82
|
Use `className` for styles that are NOT covered by props:
|
|
@@ -100,3 +106,4 @@ If a component doesn't support a prop you need:
|
|
|
100
106
|
- `src/components/heading.tsx` — Heading with prop overrides
|
|
101
107
|
- `src/components/paragraph.tsx` — Paragraph with prop overrides
|
|
102
108
|
- `src/components/label.tsx` — Label with prop overrides
|
|
109
|
+
- `src/components/image.tsx` — Image with prop overrides
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# 025: No Components in Blocks
|
|
2
|
+
|
|
3
|
+
**Category:** Structure
|
|
4
|
+
**Status:** Stable
|
|
5
|
+
**Enforcement:** ESLint (`gallop/no-component-in-blocks`)
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
Exported component functions must be in the components folder, not defined in block files. Non-exported content components are allowed.
|
|
10
|
+
|
|
11
|
+
## Rationale
|
|
12
|
+
|
|
13
|
+
Blocks should be self-contained page sections that import reusable components. When you define and export a component inside a block file, it:
|
|
14
|
+
|
|
15
|
+
1. **Breaks reusability** - The component can't be easily shared across other blocks
|
|
16
|
+
2. **Violates separation of concerns** - Blocks assemble components, components are building blocks
|
|
17
|
+
3. **Makes the codebase harder to navigate** - Components should live in `/components`
|
|
18
|
+
|
|
19
|
+
However, **content components** (non-exported helper functions that render specific content for that block) are allowed. These are internal to the block and not meant to be reused elsewhere.
|
|
20
|
+
|
|
21
|
+
## Bad
|
|
22
|
+
|
|
23
|
+
```tsx
|
|
24
|
+
// src/blocks/hero-1.tsx
|
|
25
|
+
export function FeatureCard({ title }: { title: string }) {
|
|
26
|
+
// ❌ Exported component - should be in components folder
|
|
27
|
+
return <div>{title}</div>
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export default function Hero1() {
|
|
31
|
+
return <FeatureCard title="Hello" />
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Good
|
|
36
|
+
|
|
37
|
+
```tsx
|
|
38
|
+
// src/blocks/hero-1.tsx
|
|
39
|
+
import { FeatureCard } from '@/components'
|
|
40
|
+
|
|
41
|
+
export default function Hero1() {
|
|
42
|
+
return <FeatureCard title="Hello" />
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```tsx
|
|
47
|
+
// src/blocks/sidebar-1.tsx
|
|
48
|
+
|
|
49
|
+
// ✅ Non-exported content component - allowed
|
|
50
|
+
function Demo1() {
|
|
51
|
+
return (
|
|
52
|
+
<div className="space-y-6">
|
|
53
|
+
<Heading as="h2">Panel 1 Content</Heading>
|
|
54
|
+
<Paragraph>This content is specific to this block...</Paragraph>
|
|
55
|
+
</div>
|
|
56
|
+
)
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// ✅ Non-exported content component - allowed
|
|
60
|
+
function Demo2() {
|
|
61
|
+
return (
|
|
62
|
+
<div className="space-y-6">
|
|
63
|
+
<Heading as="h2">Panel 2 Content</Heading>
|
|
64
|
+
<Paragraph>More specific content...</Paragraph>
|
|
65
|
+
</div>
|
|
66
|
+
)
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
const panels = {
|
|
70
|
+
demo1: <Demo1 />,
|
|
71
|
+
demo2: <Demo2 />,
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export default function Sidebar1() {
|
|
75
|
+
return (
|
|
76
|
+
<SidebarStackProvider>
|
|
77
|
+
<Section>...</Section>
|
|
78
|
+
<SidebarPanels panels={panels} />
|
|
79
|
+
</SidebarStackProvider>
|
|
80
|
+
)
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Exceptions
|
|
85
|
+
|
|
86
|
+
- **Non-exported functions** - Internal content components that render block-specific content are allowed
|
|
87
|
+
- **The default export** - The block's main component is always allowed
|
|
88
|
+
- **Non-PascalCase functions** - Utility functions (camelCase) are not checked by this rule
|
package/schema.json
CHANGED
|
@@ -289,7 +289,7 @@
|
|
|
289
289
|
"status": "stable",
|
|
290
290
|
"enforcement": "eslint",
|
|
291
291
|
"rule": "gallop/no-component-in-blocks",
|
|
292
|
-
"summary": "
|
|
292
|
+
"summary": "Exported component functions must be in components folder; non-exported content components are allowed in blocks"
|
|
293
293
|
},
|
|
294
294
|
{
|
|
295
295
|
"id": "026",
|