@react-foundry/create 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (C) 2019-2025 Crown Copyright
+Copyright (C) 2019-2026 Daniel A.C. Martin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+React Foundry - Create
+======================
+
+A project and prototype initialiser.
+
+
+Using this package
+------------------
+
+Typically you would not install this package but rather call it with
+`npx` or `npm init`. Similar to `npm init` this will not initialise Git
+or even create a directory for you. We suggest that you set up your
+directory with Git and its remote before you start. For example:
+
+```shell
+mkdir MY-PROJECT
+cd MY-PROJECT
+git init
+git remote add origin https://github.com/MY-USER/MY-PROJECT.git
+```
+
+Once that is set up you can run:
+
+```shell
+npm init @react-foundry
+```
+
+Follow the prompts to set up your new project.
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Building
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+```shell
+npm run clean
+```

package/bin/create.mjs

@@ -0,0 +1,10 @@
+#! /usr/bin/env node
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { runPlop } from '@react-foundry/plop-pack-internal';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const plopfile = resolve(__dirname, '..', 'plopfile.js');
+
+runPlop(plopfile);

package/dist/package.base.json

@@ -0,0 +1,51 @@
+{
+  "scripts": {
+    "create": "plop",
+    "create:app": "plop app",
+    "create:component": "plop component",
+    "create:lib": "plop lib",
+    "pnpm": "pnpm",
+    "pnpm:all": "npm run pnpm -- -r",
+    "pnpm:apps": "npm run pnpm:all -- --filter './apps/**'",
+    "pnpm:libs": "npm run pnpm:all -- --filter './components/**' --filter './lib/**'",
+    "pnpm:storybook": "npm run pnpm:all -- --filter './apps/storybook'",
+    "all:build": "npm run pnpm:all -- run build",
+    "all:clean": "npm run pnpm:all -- run clean",
+    "all:publish": "npm run libs:publish",
+    "apps:build": "npm run pnpm:apps -- run build",
+    "apps:clean": "npm run pnpm:apps -- run clean",
+    "libs:build": "npm run pnpm:libs -- run build",
+    "libs:clean": "npm run pnpm:libs -- run clean",
+    "libs:publish": "npm run pnpm:libs -- publish --access public",
+    "build": "npm run build:storybook",
+    "clean": "npm run clean:storybook",
+    "pnpm:devPreinstall": "cp pnpm-lock-committed.yaml pnpm-lock.yaml",
+    "preversion": "echo 'Warning: This should only be done on a fresh branch from master.'",
+    "version": "bash .npm/version.sh",
+    "postversion": "echo 'Done. You should now publish (with `npm run all:publish`), push your branch, push your tags and merge to master.'",
+    "distclean": "pnpm recursive exec -- rm -rf node_modules && rm -rf node_modules",
+    "start": "echo 'Error: This is the root of the monorepo, you should run `cd apps/YOUR_APP && npm start` or run `npm run storybook` to start Storybook.' && false",
+    "storybook": "npm run pnpm:storybook -- run dev",
+    "build:storybook": "npm run pnpm:storybook -- run build",
+    "clean:storybook": "npm run pnpm:storybook -- run clean",
+    "chromatic": "npm run pnpm:storybook -- run chromatic",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --coverage --json --outputFile=.jest-results.json"
+  },
+  "devDependencies": {
+    "@babel/core": "7.28.6",
+    "@babel/plugin-transform-export-namespace-from": "7.27.1",
+    "@babel/preset-env": "7.28.6",
+    "@babel/preset-react": "7.28.5",
+    "@babel/preset-typescript": "7.28.5",
+    "@react-foundry/plop-pack": "workspace:*",
+    "@types/jest": "30.0.0",
+    "@types/react": "19.2.9",
+    "babel-jest": "30.2.0",
+    "jest": "30.2.0",
+    "jest-environment-jsdom": "30.2.0",
+    "plop": "4.0.5",
+    "react-is": "19.2.3",
+    "ts-jest": "29.4.6",
+    "typescript": "5.9.3"
+  }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@react-foundry/create",
+  "version": "0.1.0",
+  "description": "A project and prototype initialiser.",
+  "type": "module",
+  "main": "plopfile.js",
+  "exports": {
+    ".": "./plopfile.js"
+  },
+  "bin": "bin/create.mjs",
+  "files": [
+    "/bin",
+    "/dist",
+    "/plopfile.js",
+    "/skel"
+  ],
+  "author": "Daniel A.C. Martin <npm@daniel-martin.co.uk> (http://daniel-martin.co.uk/)",
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "dependencies": {
+    "shelljs": "^0.10.0",
+    "@react-foundry/plop-pack": "^0.1.0"
+  },
+  "devDependencies": {
+    "plop": "4.0.5"
+  },
+  "scripts": {
+    "build": "make",
+    "clean": "make clean"
+  }
+}

package/plopfile.js

@@ -0,0 +1,241 @@
+import { createRequire } from 'node:module';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import shell from 'shelljs';
+
+const require = createRequire(import.meta.url);
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const skelPackage = require('./dist/package.base.json');
+const plopPack = require.resolve('@react-foundry/plop-pack');
+
+const cmd = (command, options) => {
+  const r = shell.exec(command, { ...options, async: false });
+
+  if (r.code !== 0) {
+    process.exit(r.code);
+  }
+
+  return r;
+};
+
+const shortToLong = (name) => (
+  name
+    .split(/[\-_]+/)
+    .map(str => str.charAt(0).toUpperCase() + str.slice(1))
+    .join(' ')
+);
+
+const defaultKeywords = [
+];
+
+const tarball = resolve(__dirname, 'dist', 'skel.tar');
+const tarballPrototype = resolve(__dirname, 'dist', 'skel-prototype.tar');
+
+let defaults = undefined;
+
+const init = () => {
+  console.log('Welcome.');
+  console.log('This generator / initialiser builds on top of the standard `npm init`, which writes to the current working directory; you should do the following before running this tool:');
+  console.log('  1. create a new directory for your project');
+  console.log('  2. set up version control, including hooking up to GitHub or similar service');
+  console.log('');
+
+  // Allow standard `npm init` to do its magic (so we can then build on top)
+  console.log('Creating temporary package.json with `npm init`...');
+  cmd('npm init -y', { silent: true });
+  shell.mv('package.json', 'default.package.json');
+  console.log('... Done.');
+
+  // Parse in the output
+  const npmDefaults = require(resolve(process.cwd(), './default.package.json'));
+  defaults = {
+    ...skelPackage,
+    ...npmDefaults,
+    scripts: { ...skelPackage.scripts, ...npmDefaults.scripts }
+  };
+
+  // Clean up
+  console.log('Cleaning up temporary package.json...');
+  shell.rm('default.package.json');
+  console.log('... Done.');
+
+  console.log('');
+};
+
+export const plopFile = async (plop) => {
+  plop.load(plopPack, undefined, { actionTypes: true, generators: false, helpers: true, partials: false });
+
+  if (!defaults) {
+    init();
+  }
+
+  const patchPackage = file => [
+    {
+      type: 'modify',
+      path: file,
+      pattern: /"name": "@.*\/(.+)"/,
+      template: '"name": "@{{{name}}}/$1"'
+    },
+    {
+      type: 'modify',
+      path: file,
+      pattern: /"version": ".*"/,
+      template: '"version": "{{{version}}}"'
+    },
+    {
+      type: 'modify',
+      path: file,
+      pattern: /"license": ".*"/,
+      template: '"license": "{{{license}}}"'
+    },
+    {
+      type: 'modify',
+      path: file,
+      pattern: /"author": ".*"/,
+      template: `"author": "${defaults.author}"`
+    }
+  ];
+
+  plop.setGenerator('project', {
+    description: 'Project',
+    prompts: [
+      {
+        type: 'input',
+        name: 'name',
+        message: 'Short name (e.g. "my-project"):',
+        default: defaults.name || undefined
+      },
+      {
+        type: 'input',
+        name: 'fullName',
+        message: 'Full name (e.g. "My project"):',
+        default: shortToLong(defaults.name) || undefined
+      },
+      {
+        type: 'input',
+        name: 'version',
+        message: 'Version:',
+        default: defaults.version || undefined
+      },
+      {
+        type: 'input',
+        name: 'description',
+        message: 'Description:',
+        default: defaults.description || undefined
+      },
+      {
+        type: 'input',
+        name: 'keywords',
+        message: 'Keywords:',
+        default: [ ...defaultKeywords, ...defaults.keywords ].join(', ') || undefined
+      },
+      {
+        type: 'input',
+        name: 'license',
+        message: 'License:',
+        default: defaults.license || undefined
+      }
+    ],
+    actions: [
+      {
+        type: 'shell',
+        command: `tar -xv --strip-components=1 -f '${tarball}'`
+      },
+      {
+        type: 'copy',
+        destination: '.jest-results.json',
+        source: 'skel/project/.jest-results.json'
+      },
+      ...patchPackage('apps/docs/package.json'),
+      {
+        type: 'write',
+        path: 'package.json',
+        content: answers => ({
+          ...defaults,
+          name: answers.name,
+          version: answers.version,
+          description: answers.description,
+          keywords: ( answers.keywords && answers.keywords.split(/,\s*/) ) || undefined,
+          license: answers.license
+        })
+      },
+      {
+        type: 'add',
+        path: 'README.md',
+        templateFile: 'skel/project/README.md.hbs'
+      },
+      {
+        type: 'message',
+        content: 'Done. (You can install dependencies with `pnpm i` and you may then want to commit with `git add . && git commit -m \'Initial commit\'`.)'
+      }
+    ]
+  });
+
+  plop.setGenerator('prototype', {
+    description: 'Prototype (stand-alone application)',
+    prompts: [
+      {
+        type: 'input',
+        name: 'name',
+        message: 'Short name (e.g. "my-prototype"):',
+        default: defaults.name || undefined
+      },
+      {
+        type: 'input',
+        name: 'fullName',
+        message: 'Full name (e.g. "My prototype"):',
+        default: shortToLong(defaults.name) || undefined
+      },
+      {
+        type: 'input',
+        name: 'version',
+        message: 'Version:',
+        default: defaults.version || undefined
+      },
+      {
+        type: 'input',
+        name: 'description',
+        message: 'Description:',
+        default: defaults.description || undefined
+      },
+      {
+        type: 'input',
+        name: 'license',
+        message: 'License:',
+        default: defaults.license || undefined
+      }
+    ],
+    actions: [
+      {
+        type: 'shell',
+        command: `tar -xv --strip-components=1 -f '${tarballPrototype}'`
+      },
+      {
+        type: 'copy',
+        destination: '.github/actions/setup/action.yml',
+        source: 'skel/prototype/.github/actions/setup/action.yml'
+      },
+      {
+        type: 'copy',
+        destination: '.github/workflows/change-assurance.yml',
+        source: 'skel/prototype/.github/workflows/change-assurance.yml'
+      },
+      {
+        type: 'copy',
+        destination: '.github/workflows/deploy.yml',
+        source: 'skel/prototype/.github/workflows/deploy.yml'
+      },
+      {
+        type: 'merge',
+        path: 'package.json',
+        templateFile: 'skel/prototype/package.json.hbs'
+      },
+      {
+        type: 'message',
+        content: 'Done. (You may want to commit this with `git add . && git commit -m \'Initial commit\'`.)'
+      }
+    ]
+  });
+};
+
+export default plopFile;

package/skel/project/.jest-results.json

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

package/skel/project/README.md.hbs

@@ -0,0 +1,101 @@
+{{#mdTitle}}{{{fullName}}}{{/mdTitle}}
+
+{{{description}}}
+
+
+Welcome to your new project
+---------------------------
+
+Your project is a monorepo managed via [pnpm]. You can build multiple
+packages from this one repository. Packages come in the following
+varieties:
+- Applications (found in [apps/])
+- Libraries (found in [lib/])
+- Components (found in [components/])
+
+**Note:** If you would like add more varieties you can do so by modifying
+your [pnpm-workspace.yaml] and [plopfile.js].
+
+
+Getting started
+---------------
+
+In order to work on this repository you will need to [install pnpm].
+
+Once you have it installed you can pull down NPM dependencies for the
+entire project by running:
+
+```shell
+pnpm install
+```
+
+
+Creating a new package
+----------------------
+
+To create a new package, simply run:
+```shell
+npm run create
+```
+
+This is all orchestrated from your [plopfile.js] so you can modify how
+it works.
+
+See: [PLOP]
+
+
+Installing your packages
+------------------------
+
+You will often need to install the libraries and components that you create into
+each other or into your applications. This can be done as follows:
+
+```shell
+pnpm add --workspace @{{{ dashCase name }}}/your-new-package
+```
+
+Under the hood, this will create a symlink so you need not worry about
+updates. This helps when working on mutliple packages at the same time.
+
+
+Your documentation
+------------------
+
+Your project comes with its own [documentation application] to allow you
+to easily document your project, including any components that you create.
+
+You can run it as you would any other application in your project:
+
+```shell
+cd apps/docs
+npm run dev
+```
+
+We advise that you set up CI to publish your documentation site when
+pushing to the `master` branch.
+
+
+Continuous Integration
+----------------------
+
+You project comes with configuration files for running Continuous
+Integration (CI) via [GitHub Actions]. These files are found in the
+[.github/workflows] directory.
+
+If you add the required secrets to your GitHub repository, it is also
+possible to quickly set up Continuous Deployment (CD) for your
+documentation to [Netlify].
+
+
+[pnpm]: https://pnpm.io
+[apps/]: ./apps/
+[lib/]: ./lib/
+[components/]: ./components/
+[pnpm-workspace.yaml]: ./pnpm-workspace.yaml
+[plopfile.js]: ./plopfile.js
+[install pnpm]: https://pnpm.io/installation
+[PLOP]: https://plopjs.com/
+[documentation application]: ./apps/docs
+[GitHub Actions]: https://github.com/features/actions
+[.github/workflows]: ./.github/workflows
+[Netlify]: https://www.netlify.com/

package/skel/prototype/.github/actions/setup/action.yml

@@ -0,0 +1,28 @@
+name: Set-up
+description: Set-up for building, testing and deployment of standalone Catalyse apps
+inputs:
+  node:
+    description: The version of Node.js to use.
+    required: false
+    default: 22
+runs:
+  using: composite
+  steps:
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v6
+      with:
+        node-version: ${{ inputs.node }}
+        cache: 'npm'
+
+    - name: Cache Cypress.io
+      uses: actions/cache@v5
+      env:
+        cache-hash: ${{ hashFiles('pnpm-lock.yaml') }}
+      with:
+        path: '~/.cache/Cypress'
+        key: cypress-os_${{ runner.os }}-lock_${{ env.cache-hash }}
+
+    - name: Pull dependencies
+      shell: bash
+      run: 'if [[ -f "package-lock.json" ]]; then npm ci; else npm install; fi'

package/skel/prototype/.github/workflows/change-assurance.yml

@@ -0,0 +1,80 @@
+name: Change assurance
+on:
+  pull_request:
+jobs:
+  common:
+    name: Dependencies, Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ '18', '20', '22' ]
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node: ${{ matrix.node }}
+
+      - name: Run unit tests
+        uses: ./.github/actions/test-code
+
+  build-app:
+    name: Build application
+    needs:
+      - common
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node: 22
+
+      - name: Build
+        uses: ./.github/actions/build-app
+
+      - name: Save build directory
+        uses: actions/upload-artifact@v6
+        with:
+          name: 'build'
+          path: "dist"
+          if-no-files-found: error
+          retention-days: 2
+
+  test-app:
+    name: Test application
+    needs:
+      - build-app
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        browser: [ 'chromium', 'firefox', 'electron' ]
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node: 22
+
+      - name: Download build directory
+        uses: actions/download-artifact@v7
+        with:
+          name: 'build'
+          path: "dist"
+
+      - name: Run functional tests
+        uses: './.github/actions/test-app'
+        with:
+          browser: ${{ matrix.browser }}
+          cypress-project-id: ${{ secrets.CYPRESS_PROJECT_ID }}
+          cypress-record-key: ${{ secrets.CYPRESS_RECORD_KEY }}
+          node: ${{ matrix.node }}

package/skel/prototype/.github/workflows/deploy.yml

@@ -0,0 +1,4 @@
+name: Deploy
+on:
+  push:
+jobs:

package/skel/prototype/package.json.hbs

@@ -0,0 +1,6 @@
+{
+  "name": "{{{name}}}",
+  "version": "{{{version}}}",
+  "description": "{{{description}}}",
+  "license": "{{{license}}}"
+}