generator-folklore 3.0.41 → 3.0.44

package/lib/generators/agents/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _generator = _interopRequireDefault(require("../../lib/generator"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class AgentsGenerator extends _generator.default {
+  prompting() {
+    if (this.options.quiet) {
+      return;
+    }
+    console.log(_chalk.default.yellow('\n----------------------'));
+    console.log('AGENTS.md Generator');
+    console.log(_chalk.default.yellow('----------------------\n'));
+  }
+  writing() {
+    const destPath = this.destinationPath('AGENTS.md');
+    const hasComposerJson = this.fs.exists(this.destinationPath('composer.json'));
+    const hasPackageJson = this.fs.exists(this.destinationPath('package.json'));
+    const existingContent = this.fs.exists(destPath) ? this.fs.read(destPath) : '';
+    const separator = '\n\n---\n\n';
+    const parts = [this.fs.read(this.templatePath('general.md')), hasComposerJson ? this.fs.read(this.templatePath('laravel.md')) : null, hasPackageJson ? this.fs.read(this.templatePath('frontend.md')) : null].filter(it => it !== null).join(separator);
+    const newContent = existingContent.length > 0 ? `${existingContent}${separator}${parts}` : parts;
+    this.fs.write(destPath, newContent);
+  }
+}
+exports.default = AgentsGenerator;

package/lib/generators/agents/templates/frontend.md

@@ -0,0 +1,21 @@
+## Frontend (TypeScript / React / CSS)
+
+### Tech stack
+- React 19 (with React compiler)
+- Typescript
+- CSS Modules (PostCSS processing with nesting supported)
+- React Query for network request
+- React Intl (format-js) for i18n
+
+### Architecture
+- Use custom contexts for global access to data
+- Create custom hooks when appropriate
+- Use API class to handle data fetching and mutation
+
+### Style and conventions
+- Don't use memoisation `useCallback` and `useMemo` (project use react-compiler)
+- Use pure function components with type hinted props. Make a separate interface for component props
+- Extends props interface when composing components
+- Organize global types in `.d.ts` files in the `types` folder
+- Add className props for style composition and when needed add className props for inner elements
+- Don't write string, use i18n components from react-intl

package/lib/generators/agents/templates/general.md

@@ -0,0 +1,21 @@
+# AGENTS.md
+
+This file defines how coding agents should work in this repository.
+
+## Scope
+
+- Applies to the whole repository unless a deeper `AGENTS.md` overrides part of it.
+
+## Language Rules
+
+- Write all code, comments, identifiers, commit messages, and technical docs in English.
+- User-facing chat can be in French, but repository content stays in English.
+
+## Editing Guidelines
+
+- Keep changes minimal and focused on the requested task.
+- Follow existing style and file organization before introducing new patterns.
+- Do not refactor unrelated areas unless required for the task.
+- Avoid renaming public exports unless explicitly requested.
+- Add a suffix to file names with to group concerns and help with file finding (ex: `forms/LoginForm.tsx` instead of just `forms/Login.tsx`, `forms/login-form.module.css` instead of just `forms/login.module.css`, `Repositories/UsersRepositories.php` instead of `Repositories/Users.php`). The only exception is base Entities which should not contain Entity suffix.
+

package/lib/generators/agents/templates/laravel.md

@@ -0,0 +1,13 @@
+## Backend (PHP / Laravel)
+
+### Architecture
+- Use **Entity** defined in `app/Contracts/Entities` and `app/Entities` instead of using directly Models. Entity wraps models and provide a typehinted interface to interact with data
+- Use typed entities when representing an entity with variations (ex: Page entity might have HomePage, ContactPage)
+- Use **Repository** defined in `app/Contracts/Repositories` and `app/Repositories` instead of querying models directly
+
+### Style and conventions
+- Use Contracts and dependency injection
+- Typehint methods and properties
+- Use `once` in class to prevent recreation of objects
+- Treat Entity as immutable
+- Create class property in constructor when needed

package/lib/generators/babel/index.js

@@ -10,21 +10,11 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 class BabelGenerator extends _generator.default {
   constructor(...args) {
     super(...args);
-    this.option('react', {
-      type: Boolean,
-      required: false,
-      defaults: false
-    });
     this.option('transform-runtime', {
       type: Boolean,
       required: false,
       defaults: false
     });
-    this.option('react-intl', {
-      type: Boolean,
-      required: false,
-      defaults: false
-    });
   }
   prompting() {
     if (this.options.quiet) {
@@ -38,26 +28,20 @@ class BabelGenerator extends _generator.default {
     return {
       config() {
         const {
-          react,
-          'transform-runtime': transformRuntime,
-          'react-intl': reactIntl
+          'transform-runtime': transformRuntime
         } = this.options;
-        const srcPath = this.templatePath('config.js');
+        const srcPath = this.templatePath('config.ejs');
         const destPath = this.destinationPath('babel.config.js');
         this.fs.copyTpl(srcPath, destPath, {
-          react,
-          transformRuntime,
-          reactIntl
+          transformRuntime
         });
       },
       dependencies() {
         this.addDevDependencies({
-          '@babel/core': '^7.19.3',
-          '@babel/cli': 'latest',
-          '@babel/node': 'latest',
           '@babel/plugin-transform-runtime': 'latest',
-          '@babel/preset-env': 'latest',
-          '@babel/preset-react': 'latest'
+          'babel-plugin-formatjs': '^11.3.7',
+          'babel-plugin-lodash': '^3.3.4',
+          'babel-plugin-react-compiler': '^1.0.0'
         });
       }
     };

package/lib/generators/babel/templates/config.ejs

@@ -0,0 +1,41 @@
+module.exports = {
+    plugins: [
+        [
+            require.resolve('babel-plugin-formatjs'),
+            {
+                removeDefaultMessage: process.env.NODE_ENV === 'production',
+                idInterpolationPattern: '[sha512:contenthash:base64:6]',
+            },
+        ],
+        [require.resolve('babel-plugin-lodash'), {}],
+        [
+            require.resolve('babel-plugin-react-compiler'),
+            {
+                // compilationMode: 'annotation',
+                logger: {
+                    logEvent(filename, event) {
+                        if (event.kind === 'CompileError') {
+                            console.error(`\nCompilation failed: ${filename}`);
+                            console.error(`Reason: ${event.detail.reason}`);
+
+                            if (event.detail.description) {
+                                console.error(`Details: ${event.detail.description}`);
+                            }
+
+                            if (event.detail.loc) {
+                                const { line, column } = event.detail.loc.start;
+                                console.error(`Location: Line ${line}, Column ${column}`);
+                            }
+
+                            if (event.detail.suggestions) {
+                                console.error('Suggestions:', event.detail.suggestions);
+                            }
+                        }
+                    },
+                },
+            },
+        ],<% if (transformRuntime) { %>
+        [require.resolve('@babel/plugin-transform-runtime'), {}],
+<% } %>
+    ],
+};

package/lib/generators/eslint/index.js

@@ -25,14 +25,13 @@ class EslintGenerator extends _generator.default {
       },
       dependencies() {
         this.addDevDependencies({
-          '@babel/eslint-parser': '^7.18.9',
-          '@babel/preset-typescript': '^7.26.0',
-          '@eslint-react/eslint-plugin': '^2.0.0',
-          eslint: '^9.36.0',
+          '@eslint-react/eslint-plugin': '^5.6.0',
+          '@eslint/js': '^9.39.4',
+          eslint: '^10.0.0',
           'eslint-config-prettier': '^10.1.8',
-          'eslint-plugin-formatjs': '^5.4.0',
-          'eslint-plugin-import': '^2.32.0',
+          'eslint-plugin-formatjs': '^6.4.6',
           'eslint-plugin-prettier': '^5.5.4',
+          globals: '^17.5.0',
           typescript: '^5.7.3',
           'typescript-eslint': '^8.25.0'
         });

package/lib/generators/eslint/templates/.eslint.config.js

@@ -1,13 +1,12 @@
-import formatjs from 'eslint-plugin-formatjs';
+import eslintReact from '@eslint-react/eslint-plugin';
 import globals from 'globals';
-import babelParser from '@babel/eslint-parser';
-import importPlugin from 'eslint-plugin-import';
 import js from '@eslint/js';
-import tseslint from 'typescript-eslint';
+import formatjs from 'eslint-plugin-formatjs';
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
-import eslintReact from '@eslint-react/eslint-plugin';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
 
-export default tseslint.config(
+export default defineConfig(
     {
         files: ['**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx'],
     },
@@ -32,23 +31,9 @@ export default tseslint.config(
             },
         },
     },
-    {
-        languageOptions: {
-            parser: babelParser,
-            parserOptions: {
-                ecmaVersion: 'latest',
-                requireConfigFile: false,
-                babelOptions: {
-                    presets: ['@babel/preset-react', '@babel/preset-typescript'],
-                },
-            },
-        },
-    },
     js.configs.recommended,
     tseslint.configs.recommended,
     eslintReact.configs['recommended-typescript'],
-    importPlugin.flatConfigs.typescript,
-    importPlugin.flatConfigs.recommended,
     formatjs.configs.recommended,
     eslintPluginPrettierRecommended,
     {

package/lib/generators/html-project/index.js

@@ -124,6 +124,10 @@ class HTMLProjectGenerator extends _generator.default {
     this.composeWith('folklore:editorconfig', {
       quiet: true
     });
+    this.composeWith('folklore:babel', {
+      'skip-install': true,
+      quiet: true
+    });
     this.composeWith('folklore:react-app', {
       'project-name': projectName,
       path: jsSrcPath,
@@ -146,6 +150,10 @@ class HTMLProjectGenerator extends _generator.default {
         quiet: true
       });
     }
+    this.composeWith('folklore:agents', {
+      'src-path': srcPath,
+      quiet: true
+    });
     this.log('merging with folklore build');
     this.composeWith('folklore:build', {
       'src-path': srcPath,

package/lib/generators/intl/index.js

@@ -14,7 +14,7 @@ class IntlGenerator extends _generator.default {
     this.option('translations-path', {
       type: String,
       desc: 'Path for to search for translations',
-      defaults: './src/**/*.{js,jsx}'
+      defaults: './src/**/*.{js,jsx,tsx}'
     });
     this.option('locales', {
       type: String,

package/lib/generators/laravel/index.js

@@ -66,7 +66,7 @@ class LaravelGenerator extends _generator.default {
     this.option('assets-path', {
       type: String,
       desc: 'Path for assets',
-      defaults: 'resources/assets'
+      defaults: 'resources'
     });
     this.option('public-path', {
       type: String,
@@ -291,7 +291,7 @@ class LaravelGenerator extends _generator.default {
         });
       },
       removeFiles() {
-        const files = ['gulpfile.js', 'package.json', 'webpack.mix.js', 'config/app.php', 'routes/web.php', 'public/css/app.css', 'public/js/app.js', 'app/Exceptions/Handler.php', 'app/Providers/AppServiceProvider.php', 'resources/sass/**', 'resources/js/**', 'resources/sass', 'resources/js', 'resources/assets/sass/**', 'resources/assets/js/**', 'resources/assets/sass', 'resources/assets/js', 'resources/views/welcome.blade.php', 'resources/views/errors/404.blade.php', 'resources/views/errors/500.blade.php'];
+        const files = ['gulpfile.js', 'package.json', 'webpack.mix.js', 'config/app.php', 'routes/web.php', 'public/css/app.css', 'public/js/app.js', 'app/Exceptions/Handler.php', 'app/Providers/AppServiceProvider.php', 'resources/sass/**', 'resources/js/**', 'resources/styles', 'resources/js', 'resources/styles/**', 'resources/js/**', 'resources/styles', 'resources/js', 'resources/views/welcome.blade.php', 'resources/views/errors/404.blade.php', 'resources/views/errors/500.blade.php'];
         files.forEach(file => {
           const filePath = this.destinationPath(file);
           this.fs.delete(filePath);

package/lib/generators/laravel-auth/index.js

@@ -19,11 +19,11 @@ class LaravelAuthGenerator extends _generator.default {
     });
     this.option('js-path', {
       type: String,
-      defaults: 'resources/assets/js'
+      defaults: 'resources/js'
     });
     this.option('styles-path', {
       type: String,
-      defaults: 'resources/assets/styles'
+      defaults: 'resources/styles'
     });
   }
   get prompting() {
@@ -62,7 +62,7 @@ class LaravelAuthGenerator extends _generator.default {
         this.fs.writeJSON(destPath, _lodash.default.merge(currentJson, newJson));
       },
       files() {
-        const folders = ['app', 'resources', 'routes', 'database'];
+        const folders = ['app', 'resources', 'routes', 'database', 'lang'];
         const jsPath = this.options['js-path'] || null;
         const stylesPath = this.options['styles-path'] || null;
         folders.forEach(folder => {

package/lib/generators/laravel-panneau/index.js

@@ -97,7 +97,7 @@ class LaravelPanneauGenerator extends _generator.default {
       },
       indexJs() {
         const source = this.templatePath('index.ts');
-        const destination = this.destinationPath('resources/assets/js/index.ts');
+        const destination = this.destinationPath('resources/js/index.ts');
         this.fs.copyTpl(source, destination, {});
       },
       files() {

package/lib/generators/laravel-panneau/templates/resources/{assets/js → js}/components/Panneau.tsx

@@ -31,7 +31,8 @@ const PanneauContainer = ({
 
     useEffect(() => {
         let canceled = false;
-        import(`@panneau/intl/locale/${definition.intl.locale}`).then(() => {
+        const { locale = 'fr' } = definition.intl || {};
+        import(locale === 'en' ? `@panneau/intl/locale/en` : `@panneau/intl/locale/fr`).then(() => {
             if (!canceled) {
                 setLocaleLoaded(true);
             }

package/lib/generators/laravel-project/index.js

@@ -56,7 +56,7 @@ class LaravelProjectGenerator extends _generator.default {
     this.option('assets-path', {
       type: String,
       desc: 'Path for assets',
-      defaults: 'resources/assets'
+      defaults: 'resources'
     });
     this.option('public-path', {
       type: String,
@@ -243,7 +243,7 @@ class LaravelProjectGenerator extends _generator.default {
       'skip-install': true
     });
     this.composeWith('folklore:intl', {
-      'translations-path': _path.default.join(jsSrcPath, '**/*.{js,jsx}'),
+      'translations-path': _path.default.join(jsSrcPath, '**/*.{js,jsx,tsx}'),
       'output-path': './lang',
       'without-id-only': true,
       quiet: true,
@@ -299,7 +299,7 @@ class LaravelProjectGenerator extends _generator.default {
         }
       },
       removeFiles() {
-        const files = ['package.json', 'config/app.php', 'config/auth.php', 'routes/web.php', 'vite.config.js', 'resources/css', 'resources/js', 'resources/views/welcome.blade.php', 'app/Http/Controllers/HomeController.php', 'app/Http/Middleware/TrustProxies.php', 'app/Models/User.php'];
+        const files = ['.gitignore', 'package.json', 'config/app.php', 'config/auth.php', 'routes/web.php', 'vite.config.js', 'resources/css', 'resources/js', 'resources/views/welcome.blade.php', 'app/Http/Controllers/HomeController.php', 'app/Http/Middleware/TrustProxies.php', 'app/Models/User.php'];
         files.forEach(file => {
           const filePath = this.destinationPath(file);
           this.fs.delete(filePath);
@@ -328,11 +328,11 @@ class LaravelProjectGenerator extends _generator.default {
         this.packageJson.merge({
           scripts: {
             clean: 'rm -rf public/static && rm -rf public/precache-*',
-            'build:scripts': 'flklr build --load-env ./resources/assets/js/index.ts',
+            'build:scripts': 'flklr build --load-env ./resources/js/index.ts',
             'build:views': 'php artisan assets:view',
             build: 'npm run clean && npm run build:scripts && npm run build:views',
             start: 'npm run server',
-            server: 'flklr serve --load-env ./resources/assets/js/index.ts'
+            server: 'flklr serve --load-env ./resources/js/index.ts'
           }
         });
       },
@@ -375,6 +375,11 @@ class LaravelProjectGenerator extends _generator.default {
         // const destProd = this.destinationPath('.env.prod');
         // this.fs.copyTpl(srcProd, destProd, prodTemplateData);
       },
+      gitignore() {
+        const src = this.templatePath('gitignore');
+        const dest = this.destinationPath('.gitignore');
+        this.fs.copy(src, dest);
+      },
       files() {
         const templatePath = this.templatePath('laravel');
         const destinationPath = this.destinationPath();

package/lib/generators/laravel-project/templates/gitignore

@@ -0,0 +1,28 @@
+*.log
+.DS_Store
+.env
+.env.backup
+.env.production
+.phpactor.json
+.phpunit.result.cache
+/.fleet
+/.idea
+/.nova
+/.phpunit.cache
+/.vscode
+/.zed
+/auth.json
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/storage/pail
+/vendor
+Homestead.json
+Homestead.yaml
+Thumbs.db
+/.claude
+
+/public/static
+/public/asset-manifest.json

package/lib/generators/react-app/templates/_package.json

@@ -2,7 +2,6 @@
     "name": "",
     "version": "0.1.0",
     "private": true,
-    "type": "module",
     "author": {
         "name": "Folklore",
         "email": "info@folklore.email"

package/lib/generators/react-app/templates/types/base.d.ts

@@ -13,52 +13,6 @@ interface Theme {
     name: string;
 }
 
-interface ImageSize {
-    id: string;
-    url: string;
-    width: number;
-    height: number;
-}
-
-interface Source {
-    id: string;
-    mime?: string | null;
-    url: string;
-    size?: number | null;
-}
-
-interface Embed {
-    provider: string;
-    iframeUrl?: string;
-    html?: string;
-}
-
-interface Media {
-    id: string;
-    type: string;
-    url: string;
-    thumbnail_url?: string | null;
-    name?: string | null;
-    description?: string | null;
-    files?: Record<string, Source>;
-}
-
-interface Image extends Media, ImageSize {
-    type: 'image';
-    sizes: ImageSize[];
-    credits?: string;
-}
-
-interface Audio extends Media {
-    type: 'audio';
-}
-
-interface Video extends Media {
-    type: 'video';
-    embed?: Embed;
-    sources?: Source[];
-}
-
 interface MenuItem {
     id: string;
     url: string;
@@ -69,17 +23,10 @@ interface MenuItem {
     icon?: ReactNode;
 }
 
-interface Page {
-    id: string;
-    title?: string | null;
-    slug?: string | null;
-    path?: string | null;
-    description?: string | null;
-    image?: Image | null;
-}
-
 interface User {
     id: string;
+    name?: string | null;
+    email?: string | null;
     [key: string]: unknown;
 }
 

package/lib/generators/react-app/templates/types/forms.d.ts

@@ -1,4 +1,4 @@
-interface BaseField {
+interface Field {
     name: string;
     type: string;
     component?: string;
@@ -12,7 +12,7 @@ interface FieldOption {
     label: string;
 }
 
-interface OptionsField extends BaseField {
+interface OptionsField extends Field {
     type: 'options';
     options: FieldOption[];
     multiple?: boolean;
@@ -26,13 +26,13 @@ interface SelectField extends OptionsField {
     type: 'select';
 }
 
-interface TextField extends BaseField {
+interface TextField extends Field {
     type: 'text';
 }
 
-type FormBaseField = OptionsField | TextField | BaseField;
+type FormBaseField = OptionsField | TextField | Field;
 
-interface GroupField extends BaseField {
+interface GroupField extends Field {
     type: 'group';
     fields: FormBaseField[];
 }
@@ -48,8 +48,3 @@ interface Form {
 interface FormErrors {
     [fieldName: string]: string[] | null;
 }
-
-interface FormSnippet {
-    id: string;
-    title?: string;
-}

package/lib/generators/react-app/templates/types/medias.d.ts

@@ -0,0 +1,45 @@
+interface ImageSize {
+    id: string;
+    url: string;
+    width: number;
+    height: number;
+}
+
+interface MediaSource {
+    id: string;
+    mime?: string | null;
+    url: string;
+    size?: number | null;
+}
+
+interface Embed {
+    provider: string;
+    iframeUrl?: string;
+    html?: string;
+}
+
+interface Media {
+    id: string;
+    type: string;
+    url: string;
+    thumbnail_url?: string | null;
+    name?: string | null;
+    description?: string | null;
+    files?: Record<string, MediaSource>;
+    sources?: MediaSource[];
+}
+
+interface ImageMedia extends Media, ImageSize {
+    type: 'image';
+    sizes: ImageSize[];
+    credits?: string;
+}
+
+interface AudioMedia extends Media {
+    type: 'audio';
+}
+
+interface VideoMedia extends Media {
+    type: 'video';
+    embed?: Embed;
+}

package/lib/generators/react-app/templates/types/{blocks.d.ts → pages.d.ts}

@@ -1,3 +1,14 @@
+
+interface BaseCard {
+    id: string;
+    type: string;
+    title?: string | null;
+    description?: string | null;
+    image?: Image | null;
+}
+
+type Card = BaseCard;
+
 interface BaseBlock {
     id: string;
     uuid?: string;
@@ -30,12 +41,13 @@ interface CardsBlock extends BaseBlock {
 
 type Block = TextBlock | ImageBlock | HeadingBlock | CardsBlock | BaseBlock;
 
-interface BaseCard {
+interface BasePage {
     id: string;
-    type: string;
     title?: string | null;
+    slug?: string | null;
+    path?: string | null;
     description?: string | null;
     image?: Image | null;
 }
 
-type Card = BaseCard;
+type Page = BasePage;

package/lib/generators/svgo/templates/config.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     plugins: [
         {
             name: 'preset-default',

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "generator-folklore",
-    "version": "3.0.41",
+    "version": "3.0.44",
     "description": "Yeoman generator for projects at Folklore",
     "keywords": [
         "yeoman-generator"
@@ -40,5 +40,5 @@
         "yeoman-generator": "5.9.0",
         "yeoman-remote": "^1.0.1"
     },
-    "gitHead": "fa6a949c878272c2849b3061ca248ffbf83fce91"
+    "gitHead": "c8fe7d293f1faa1a2448210c407a078b95bf7c83"
 }

package/lib/generators/babel/templates/config.js

@@ -1,16 +0,0 @@
-module.exports = {
-    presets: [
-        [
-            require.resolve('@babel/preset-env'),
-            {
-                useBuiltIns: false
-            },
-        ],
-    ],
-
-    plugins: [
-        <% if (transformRuntime) { %>
-        [require.resolve('@babel/plugin-transform-runtime'), {}],
-        <% } %>
-    ],
-};

package/lib/generators/react-app/templates/types/metadata.d.ts

@@ -1,36 +0,0 @@
-interface Microformat {
-    '@context': string;
-    '@type': string;
-    identifier: string;
-    [key: string]: unknown;
-}
-
-interface Taxonomy {
-    id: string;
-    type: string;
-    label: string;
-    slug: string;
-}
-
-interface Category extends Taxonomy {
-    type: 'category';
-}
-
-interface Author {
-    id: string;
-    slug: string;
-    name: string;
-    image?: Image | null;
-    isPerson?: boolean;
-}
-
-interface Credit {
-    author?: Author | null;
-    name?: string | null;
-    role?: string;
-}
-
-interface Organisation {
-    id: string;
-    name: string;
-}