create-turbo 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. package/dist/index.js +8 -1
  2. package/package.json +1 -1
  3. package/templates/npm/README.md +78 -0
  4. package/templates/pnpm/README.md +78 -0
  5. package/templates/yarn/README.md +78 -0
package/dist/index.js CHANGED
@@ -31,7 +31,7 @@ var import_chalk = __toModule(require("chalk"));
31
31
 
32
32
  // package.json
33
33
  var name = "create-turbo";
34
- var version = "1.0.0";
34
+ var version = "1.0.1";
35
35
  var description = "Create a new Turborepo";
36
36
  var homepage = "https://turborepo.org";
37
37
  var license = "MPL-2.0";
@@ -244,6 +244,13 @@ async function run() {
244
244
  }
245
245
  await import_fs_extra.default.move(path2.join(projectDir, "gitignore"), path2.join(projectDir, ".gitignore"));
246
246
  let appPkg = require(path2.join(sharedTemplate, "package.json"));
247
+ ["dependencies", "devDependencies"].forEach((pkgKey) => {
248
+ for (let key in appPkg[pkgKey]) {
249
+ if (appPkg[pkgKey][key] === "*") {
250
+ appPkg[pkgKey][key] = `latest`;
251
+ }
252
+ }
253
+ });
247
254
  await import_fs_extra.default.writeFile(path2.join(projectDir, "package.json"), JSON.stringify(appPkg, null, 2));
248
255
  if (answers.install) {
249
256
  console.log();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-turbo",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Create a new Turborepo",
5
5
  "homepage": "https://turborepo.org",
6
6
  "license": "MPL-2.0",
package/templates/npm/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Turborepo starter with NPM
2
+
3
+ This is an official starter turborepo.
4
+
5
+ ## What's inside?
6
+
7
+ This turborepo uses [NPM](https://www.npmjs.com/) as a package manager. It includes the following packages/apps:
8
+
9
+ ### Apps and Packages
10
+
11
+ - `docs`: a [Next.js](https://nextjs.org) app
12
+ - `web`: another [Next.js](https://nextjs.org) app
13
+ - `ui`: a stub React component library shared by both `web` and `docs` applications
14
+ - `config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
15
+ - `tsconfig`: `tsconfig.json`s used throughout the monorepo
16
+
17
+ Each package/app is 100% [Typescript](https://www.typescriptlang.org/).
18
+
19
+ ### Utilities
20
+
21
+ This turborepo has some additional tools already setup for you:
22
+
23
+ - [Typescript](https://www.typescriptlang.org/) for static type checking
24
+ - [ESLint](https://eslint.org/) for code linting
25
+ - [Jest](https://jestjs.io) test runner for all things JavaScript
26
+ - [Prettier](https://prettier.io) for code formatting
27
+
28
+ ## Setup
29
+
30
+ This repository is used in the `npx create-turbo` command, and selected when choosing which package manager you wish to use with your monorepo (NPM).
31
+
32
+ ### Build
33
+
34
+ To build all apps and packages, run the following command:
35
+
36
+ ´´´
37
+ cd my-turborepo
38
+ npm run build
39
+ ´´´
40
+
41
+ ### Develop
42
+
43
+ To develop all apps and packages, run the following command:
44
+
45
+ ´´´
46
+ cd my-turborepo
47
+ npm run dev
48
+ ´´´
49
+
50
+ ### Remote Caching
51
+
52
+ Turborepo can use a technique known as [Remote Caching (Beta)](https://turborepo.org/docs/features/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
53
+
54
+ By default, Turborepo will cache locally. To enable Remote Caching (Beta) you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
55
+
56
+ ´´´
57
+ cd my-turborepo
58
+ npx turbo login
59
+ ´´´
60
+
61
+ This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
62
+
63
+ Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
64
+
65
+ ´´´
66
+ npx turbo link
67
+ ´´´
68
+
69
+ ## Useful Links
70
+
71
+ Learn more about the power of Turborepo:
72
+
73
+ - [Pipelines](https://turborepo.org/docs/features/pipelines)
74
+ - [Caching](https://turborepo.org/docs/features/caching)
75
+ - [Remote Caching (Beta)](https://turborepo.org/docs/features/remote-caching)
76
+ - [Scoped Tasks](https://turborepo.org/docs/features/scopes)
77
+ - [Configuration Options](https://turborepo.org/docs/reference/configuration)
78
+ - [CLI Usage](https://turborepo.org/docs/reference/command-line-reference)
package/templates/pnpm/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Turborepo starter with PNPM
2
+
3
+ This is an official starter turborepo.
4
+
5
+ ## What's inside?
6
+
7
+ This turborepo uses [PNPM](https://pnpm.io) as a packages manager. It includes the following packages/apps:
8
+
9
+ ### Apps and Packages
10
+
11
+ - `docs`: a [Next.js](https://nextjs.org) app
12
+ - `web`: another [Next.js](https://nextjs.org) app
13
+ - `ui`: a stub React component library shared by both `web` and `docs` applications
14
+ - `config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
15
+ - `tsconfig`: `tsconfig.json`s used throughout the monorepo
16
+
17
+ Each package/app is 100% [Typescript](https://www.typescriptlang.org/).
18
+
19
+ ### Utilities
20
+
21
+ This turborepo has some additional tools already setup for you:
22
+
23
+ - [Typescript](https://www.typescriptlang.org/) for static type checking
24
+ - [ESLint](https://eslint.org/) for code linting
25
+ - [Jest](https://jestjs.io) test runner for all things JavaScript
26
+ - [Prettier](https://prettier.io) for code formatting
27
+
28
+ ## Setup
29
+
30
+ This repository is used in the `npx create-turbo` command, and selected when choosing which package manager you wish to use with your monorepo (PNPM).
31
+
32
+ ### Build
33
+
34
+ To build all apps and packages, run the following command:
35
+
36
+ ´´´
37
+ cd my-turborepo
38
+ pnpm run build
39
+ ´´´
40
+
41
+ ### Develop
42
+
43
+ To develop all apps and packages, run the following command:
44
+
45
+ ´´´
46
+ cd my-turborepo
47
+ pnpm run dev
48
+ ´´´
49
+
50
+ ### Remote Caching
51
+
52
+ Turborepo can use a technique known as [Remote Caching (Beta)](https://turborepo.org/docs/features/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
53
+
54
+ By default, Turborepo will cache locally. To enable Remote Caching (Beta) you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
55
+
56
+ ´´´
57
+ cd my-turborepo
58
+ npx turbo login
59
+ ´´´
60
+
61
+ This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
62
+
63
+ Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
64
+
65
+ ´´´
66
+ npx turbo link
67
+ ´´´
68
+
69
+ ## Useful Links
70
+
71
+ Learn more about the power of Turborepo:
72
+
73
+ - [Pipelines](https://turborepo.org/docs/features/pipelines)
74
+ - [Caching](https://turborepo.org/docs/features/caching)
75
+ - [Remote Caching (Beta)](https://turborepo.org/docs/features/remote-caching)
76
+ - [Scoped Tasks](https://turborepo.org/docs/features/scopes)
77
+ - [Configuration Options](https://turborepo.org/docs/reference/configuration)
78
+ - [CLI Usage](https://turborepo.org/docs/reference/command-line-reference)
package/templates/yarn/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Turborepo starter
2
+
3
+ This is an official Yarn v1 starter turborepo.
4
+
5
+ ## What's inside?
6
+
7
+ This turborepo uses [YARN](https://classic.yarnpkg.com/lang/en/) as a package manager. It includes the following packages/apps:
8
+
9
+ ### Apps and Packages
10
+
11
+ - `docs`: a [Next.js](https://nextjs.org) app
12
+ - `web`: another [Next.js](https://nextjs.org) app
13
+ - `ui`: a stub React component library shared by both `web` and `docs` applications
14
+ - `config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
15
+ - `tsconfig`: `tsconfig.json`s used throughout the monorepo
16
+
17
+ Each package/app is 100% [Typescript](https://www.typescriptlang.org/).
18
+
19
+ ### Utilities
20
+
21
+ This turborepo has some additional tools already setup for you:
22
+
23
+ - [Typescript](https://www.typescriptlang.org/) for static type checking
24
+ - [ESLint](https://eslint.org/) for code linting
25
+ - [Jest](https://jestjs.io) test runner for all things JavaScript
26
+ - [Prettier](https://prettier.io) for code formatting
27
+
28
+ ## Setup
29
+
30
+ This repository is used in the `npx create-turbo` command, and selected when choosing which package manager you wish to use with your monorepo (YARN).
31
+
32
+ ### Build
33
+
34
+ To build all apps and packages, run the following command:
35
+
36
+ ´´´
37
+ cd my-turborepo
38
+ yarn run build
39
+ ´´´
40
+
41
+ ### Develop
42
+
43
+ To develop all apps and packages, run the following command:
44
+
45
+ ´´´
46
+ cd my-turborepo
47
+ yarn run dev
48
+ ´´´
49
+
50
+ ### Remote Caching
51
+
52
+ Turborepo can use a technique known as [Remote Caching (Beta)](https://turborepo.org/docs/features/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
53
+
54
+ By default, Turborepo will cache locally. To enable Remote Caching (Beta) you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
55
+
56
+ ´´´
57
+ cd my-turborepo
58
+ npx turbo login
59
+ ´´´
60
+
61
+ This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
62
+
63
+ Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
64
+
65
+ ´´´
66
+ npx turbo link
67
+ ´´´
68
+
69
+ ## Useful Links
70
+
71
+ Learn more about the power of Turborepo:
72
+
73
+ - [Pipelines](https://turborepo.org/docs/features/pipelines)
74
+ - [Caching](https://turborepo.org/docs/features/caching)
75
+ - [Remote Caching (Beta)](https://turborepo.org/docs/features/remote-caching)
76
+ - [Scoped Tasks](https://turborepo.org/docs/features/scopes)
77
+ - [Configuration Options](https://turborepo.org/docs/reference/configuration)
78
+ - [CLI Usage](https://turborepo.org/docs/reference/command-line-reference)