pepicrft / catalysis-framework Goto Github PK

Why?

Letting Typescript generate .d.ts files for public modules at build time might lead to breaking changes happen more frequently because we rely on humans to detect them.

What

We started writing the interface of public modules in .d.ts inspired by Swift's protocol-oriented programming. With that change we still rely on humans to detect breaking changes, but at least they can see the changes in the interface in PR reviews.
The goal of this task is to implement an ESLint rule to make sure that everyone sticks to this convention.

The goal of this task is to provide an API for contributors to run system processes. It's important that this API works across OSs (macOS, Windows, and Linux). We can build upon ShellJS that already ensures there's cross-OS compatibility. As part of this task we should also:

• Update the contributors' documentation to mention they should be using that API instead of NodeJS APIs.
• Implement an ESLint rule that runs in the project and ensures the above doesn't happen.

If we end up building upon ShellJS, I recommend taking the opportunity to build a Promise-based interface that can be used with the async/await keywords built into the language. Also, I recommend abstracting away ShellJS from the rest of the codebase in case we need to replace the library in the future for anything else.

Stackblitz is a tool that enables web development right in your browser by using web cointainers. The goal of this task is to have a domain, for example, new.gestatljs.com, that creates a Stackblitz environment with an example project to play with the framework.

What?

Document how to:

• Use changeset to reflect the changes in a PR.
• The release process

The goal of this task is to add an issue and pull request templates to guide contributors towards a more standard issue and PRs' structure.

What?

Defining the dev dependencies of the project at the root might lead to things accidentally working in development but failing in production due to the Node module system works (i.e. traversing the directory hierarchy up to lookup dependencies). To eliminate the changes of shipping new versions of Gestalt that don't work after installing them, we should move the dev dependencies to a subdirectory:

gestalt/
  dev/
     package.json
  packages/
     ...

Because the package.json's scripts approach for automation can turn limiting in the future, the dev directory can be a place for a new CLI that contributors can use to contribute to the project.

The goal of this task is to define a release cadence, document the process, and automate it through GitHub actions. This page from the pnpm documentation might be a good starting point.

What?

When running Gestalt after installing it from the NPM registry, it throws an error:

/Users/pepicrft/Downloads/node_modules/.pnpm/[email protected]/node_modules/pino/lib/tools.js:413
        throw Error('option.transport.targets do not allow custom level formatters')
              ^

Error: option.transport.targets do not allow custom level formatters
    at normalizeArgs (/Users/pepicrft/Downloads/node_modules/.pnpm/[email protected]/node_modules/pino/lib/tools.js:413:15)
    at pino (/Users/pepicrft/Downloads/node_modules/.pnpm/[email protected]/node_modules/pino/pino.js:85:28)
    at Object.setupGestaltLogger (file:///Users/pepicrft/Downloads/node_modules/.pnpm/@[email protected]/node_modules/@gestaltjs/core/dist/cli/index.js:1207:25)
    at setup (file:///Users/pepicrft/Downloads/node_modules/.pnpm/[email protected]/node_modules/gestaltjs/dist/index.js:6:10)
    at file:///Users/pepicrft/Downloads/node_modules/.pnpm/[email protected]/node_modules/gestaltjs/dist/index.js:15:1
    at ModuleJob.run (node:internal/modules/esm/module_job:185:25)
    at async Promise.all (index 0)

Steps to reproduce

1. Run pnpm install gestaltjs.
2. Run node_modules/.bin/gestalt
3. It fails.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency @types/tmp to v0.2.4
• Update dependency case-anything to v2.1.13
• Update dependency handlebars to v4.7.8
• Update dependency magic-string to v0.30.4
• Update dependency pathe to v1.1.1
• Update dependency prettier to v2.8.8
• Update dependency safe-stable-stringify to v2.4.3
• Update dependency yargs to v17.7.2 (yargs, @types/yargs)
• Update docusaurus monorepo to v2.4.3 (@docusaurus/core, @docusaurus/module-type-aliases, @docusaurus/preset-classic)
• Update nrwl monorepo (@nrwl/cli, @nrwl/tao, @nrwl/workspace, nx)
• Update dependency @algolia/client-search to v4.20.0
• Update dependency @remix-run/web-fetch to v4.4.1
• Update dependency @types/node to v18.18.4
• Update dependency @types/node to v18.18.4
• Update dependency acorn to v8.10.0
• Update dependency deno to v1.37.1
• Update dependency esbuild to v0.19.4
• Update dependency eslint to v8.51.0
• Update dependency eslint-config-prettier to v8.10.0
• Update dependency eslint-plugin-import to v2.28.1
• Update dependency eslint-plugin-jest to v27.4.2
• Update dependency eslint-plugin-react to v7.33.2
• Update dependency fast-glob to v3.3.1
• Update dependency h3 to v1.8.2
• Update dependency inquirer to v9.2.11 (inquirer, @types/inquirer)
• Update dependency listhen to v1.5.5
• Update dependency node to v19.9.0
• Update dependency pnpm to v7.33.6
• Update dependency radix3 to v1.1.0
• Update dependency strip-ansi to v7.1.0
• Update dependency tempy to v3.1.0
• Update dependency unplugin to v1.5.0
• Update dependency vite to v4.4.11
• Update dependency vitest to v0.34.6
• Update dependency zod to v3.22.4
• Update pnpm/action-setup action to v2.4.0
• Update typescript-eslint monorepo to v5.62.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• Update actions/checkout action to v4
• Update dependency @cucumber/cucumber to v10
• Update dependency @oclif/core to v3
• Update dependency @shopify/eslint-plugin to v43
• Update dependency clsx to v2
• Update dependency eslint-config-prettier to v9
• Update dependency eslint-plugin-prettier to v5
• Update dependency execa to v8
• Update dependency listr2 to v7
• Update dependency prettier to v3
• Update dependency prism-react-renderer to v2
• Update nrwl monorepo (major) (@nrwl/tao, @nrwl/workspace, nrwl/nx-set-shas, nx)
• Update typescript-eslint monorepo to v6 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency @changesets/cli to v2.26.2
• Update dependency @oclif/plugin-help to v5.2.20
• Update dependency @types/fs-extra to v11.0.2
• Update dependency @types/react to v17.0.68
• Update dependency @babel/core to v7.23.0
• Update dependency @cucumber/messages to v22
• Update dependency parse-json to v7
• Update dependency pnpm to v8
• Update dependency rimraf to v5
• Update dependency typescript to v5
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency @mdx-js/react to v2
• Update react monorepo to v18 (major) (@types/react, react, react-dom)

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Implement the workflow to create a new Gestalt app in the @gestaltjs/create-app package.

I created this issue to jot down ideas from other frameworks that we could take inspiration from for Gestalt.