doesitarm/.cursorrules at master · ThatGuySam/doesitarm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/**
 * Does It ARM Project Rules
 * Customized AI behavior for maintaining app compatibility database
 *
 * Refactor in as small steps as possible so that tests are always passing.
 * Be sure to thoroughly comment added code
 * Verify that it's working with a test command
 */
module.exports = {
    // Core project settings
    project: {
        name: 'doesitarm',
        type: 'astro',
        packageManager: 'pnpm',
        nodeVersion: '>=22'
    },

    // Code style preferences
    style: {
        indentSize: 4,
        maxLineLength: 72,
        quotes: 'single',
        semicolons: false
    },

    // Testing configuration
    testing: {
        framework: 'vitest',
        pattern: 'test/**/*.test.js',
        coverage: true
    },

    // Documentation rules
    docs: {
        // Write comments as user stories instead of implementation details
        commentStyle: 'userStory',
        jsdoc: {
            required: true,
            params: true,
            returns: true
        }
    },

    // Function patterns
    functions: {
        // Prefer options object for 2+ params
        preferOptionsObject: true,

        // Always use named exports except for pages
        exports: 'named',

        // Functional components only
        reactComponents: 'functional'
    },

    // Variable naming
    naming: {
        // Avoid generic names
        forbidden: [
            'base64',
            'text',
            'data',
            'item',
            'content'
        ],

        // Prefer descriptive names
        preferred: {
            'base64': '*Base64',
            'text': '*Text',
            'data': '*Data',
            'content': '*Content'
        }
    },

    // Search functionality rules
    search: {
        // Stork search configuration
        stork: {
            version: '1.6.0',
            indexPath: 'static/search-index.st',
            tomlPath: 'static/stork.toml'
        }
    },

    // Build process
    build: {
        // Files to ignore
        ignore: [
            'node_modules',
            'dist',
            '.cache',
            '.DS_Store'
        ],

        // Required environment variables
        requiredEnv: [
            'PUBLIC_URL',
            'PUBLIC_API_DOMAIN',
            'COMMITS_SOURCE',
            'GAMES_SOURCE'
        ]
    },

    // Deployment configurations
    deployment: {
        platforms: ['netlify', 'vercel'],
        netlify: {
            buildCommand: 'pnpm run netlify-build',
            publishDir: 'dist/',
            functions: {
                directory: 'dist/functions',
                bundler: 'esbuild'
            },
            environment: {
                NPM_FLAGS: '--no-optional',
                CI: '1'
            }
        },
        vercel: {
            buildCommand: 'pnpm run vercel-build',
            distDir: 'static',
            buildSteps: [
                'test-prebuild',
                'build-lists-and-api',
                'test-postbuild-api'
            ],
            github: {
                silent: true
            }
        }
    }
}