Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

ARCHITECTURE.md

51 lines6.2 KB

1## Nomenclature
2​
3- `cta` - Create Tanstack Application
4- CTA Framework - A framework that supports the creation of a TanStack Application using a specific technology (e.g. React, Solid, Vue, etc.)
5- `code-router` - One of two _modes_ of TanStack Application. The other is `file-router`. The code router is when the applications routes are defined in code.
6- `file-router` - One of two _modes_ of TanStack Application. The other is `code-router`. The file router is when the applications routes are defined in files (usually in the `src/routes` directory).
7- `add-on` - A plugin that extends the capabilities of a TanStack Application (e.g. the `tanstack-query` add-on integrates TanStack Query into the application).
8- custom `add-on` - An externalized `add-on` contained in a single JSON file that can integate technologies that aren't covered with the built-in add-ons.
9- `starter` - An application template that is constructed from an existing CTA created application that has been modified to the customers needs. The advantage of a starter over a cloneable git repo is that when a starter is used the add-ons and project will be created using the latest version of the CTA framework and the add-ons. This reduces the versioning burden on the customer. This does come with a risk of potential breaking changes.
10​
11## CLI applications
12​
13- `create-tanstack` - The CLI application for creating a TanStack Application.
14- `create-start-app` - The CLI application for creating a TanStack Start Application.
15- `create-tsrouter-app` - The CLI application for creating a TanStack Router Application.
16​
17## Packages
18​
19- `@tanstack/cta-cli` - The command line interface for TanStack CTA.
20- `@tanstack/cta-engine` - The core engine that powers TanStack CTA.
21- `@tanstack/cta-ui` - The UI components for TanStack CTA.
22​
23## Frameworks
24​
25- `@tanstack/cta-frameworks-react-cra` - The React (Create React App) framework for TanStack CTA.
26- `@tanstack/cta-frameworks-solid` - The Solid framework for TanStack CTA.
27​
28## File Templates
29​
30The CTA system uses EJS to render the files into the final application.
31​
32Below are all of the variables that are available to the file templates.
33​
34| Variable | Description |
35| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36| `packageManager` | The package manager that is being used (e.g. `npm`, `yarn`, `pnpm`) |
37| `projectName` | The name of the project |
38| `typescript` | Boolean value that is `true` if TypeScript is being used, otherwise it is `false` |
39| `tailwind` | Boolean value that is `true` if Tailwind CSS is being used, otherwise it is `false` |
40| `js` | The file extension for files that do not include JSX. When in TypeScript mode it is `ts`. When in JavaScript mode it is `js`. |
41| `jsx` | The file extension for files that include JSX. When in TypeScript mode it is `tsx`. When in JavaScript mode it is `jsx`. |
42| `fileRouter` | Boolean value that is `true` if the file router is being used, otherwise it is `false` |
43| `codeRouter` | Boolean value that is `true` if the code router is being used, otherwise it is `false` |
44| `addOnEnabled` | An object that contains the enabled add-ons. The keys are the `id` values of the add-ons. For example, if the tanstack-query add-on is enabled the `addOnEnabled]['tanstack-query']` will be `true`. |
45| `addOns` | An array of the enabled add-on objects |
46| `integrations` | An array of the enabled integrations |
47| `routes` | An array containing all of the routes from all of the add-ons. (Used by the header and the `code-router` setup.) |
48| `getPackageManagerAddScript` | A function that returns the script to add a dependency to the project. |
49| `getPackageManagerRunScript` | A function that returns the script to run a command in the project. |
50| `relativePath` | A function that returns the relative path from the current file to the specified target file. |
51| `ignoreFile` | A function that if called will tell CTA to not include this file in the application. |