Skip to content

Commit 5d723d4

Browse files
committed
feat(yarn): change name to take advantage of yarn init
1 parent e656fe4 commit 5d723d4

File tree

5 files changed

+7
-13
lines changed

5 files changed

+7
-13
lines changed

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @openapi-typescript-infra/plop
1+
# @openapi-typescript-infra/create
22

33
A plop-based project generator and maintenance tool for [services](/openapi-typescript-infra/service). Builds tests and
44
other infra to get up and running quickly. The generally expected conventions for project naming are:
@@ -10,13 +10,7 @@ other infra to get up and running quickly. The generally expected conventions fo
1010
```
1111
mkdir my-cool-api
1212
cd my-cool-api
13-
yarn dlx @openapi-typescript-infra/plop
14-
```
15-
16-
```
17-
mkdir my-cool-api
18-
cd my-cool-api
19-
npx @openapi-typescript-infra/plop
13+
yarn init @openapi-typescript-infra
2014
```
2115

2216
After that you can run `yarn build` to vet things, then `yarn test`. Then you should get to work on your API spec, which you can find in the `api` directory of your newly created project.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@openapi-typescript-infra/plop",
2+
"name": "@openapi-typescript-infra/create",
33
"version": "1.1.0",
44
"description": "Project generator for @openapi-typescript-infra services",
55
"type": "module",

src/prompts.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import Configstore from 'configstore';
44
import parseGitConfig from 'parse-git-config';
55
import type { PromptQuestion } from 'node-plop';
66

7-
const config = new Configstore('@openapi-typescript-infra/plop');
7+
const config = new Configstore('@openapi-typescript-infra/create');
88

99
export interface OtiAnswers {
1010
name: string;

templates/all/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
{{desc}}
44

5-
This project has been made with @openapi-typescript-infra/plop. You should write a glowing and detailed README about
5+
This project has been made with @openapi-typescript-infra/create. You should write a glowing and detailed README about
66
all the things your services does. BUT, before you replace this with that, you probably want to:
77

88
* Add your OpenAPI specification details to api/{{snakeCase name}}

yarn.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -363,9 +363,9 @@ __metadata:
363363
languageName: node
364364
linkType: hard
365365

366-
"@openapi-typescript-infra/plop@workspace:.":
366+
"@openapi-typescript-infra/create@workspace:.":
367367
version: 0.0.0-use.local
368-
resolution: "@openapi-typescript-infra/plop@workspace:."
368+
resolution: "@openapi-typescript-infra/create@workspace:."
369369
dependencies:
370370
"@commitlint/cli": ^17.6.3
371371
"@commitlint/config-conventional": ^17.6.3

0 commit comments

Comments
 (0)