Skip to content

Commit

Permalink
changed the package install instructions to install the .tgz package … (
Browse files Browse the repository at this point in the history 
OpenAPITools#1989)

* changed the package install instructions to install the .tgz package instead of symlinking the package - otherwise you'll get trouble with links on windows

* samples added

* added samples
  • Loading branch information
@MBcom @wing328
MBcom authored and wing328 committed Feb 18, 2019
1 parent d680d18 commit 019cde7
Show file tree
Hide file tree
Showing 17 changed files with 48 additions and 20 deletions.
6 changes: 4 additions & 2 deletions modules/openapi-generator/src/main/resources/typescript-angular/README.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@ _without publishing (not recommended):_

```
{{#useNgPackagr}}
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
{{/useNgPackagr}}
{{^useNgPackagr}}
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/{{npmName}}-{{npmVersion}}.tgz --save
{{/useNgPackagr}}
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

{{#useNgPackagr}}
Expand Down
3 changes: 1 addition & 2 deletions modules/openapi-generator/src/main/resources/typescript-angular/package.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
"module": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"build": "ngc",
"postinstall": "npm run build"
"build": "ngc && npm pack"
},
{{/useNgPackagr}}
"peerDependencies": {
Expand Down
4 changes: 3 additions & 1 deletion samples/client/petstore-security-test/typescript-angular/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion samples/client/petstore/typescript-angular-v2/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion samples/client/petstore/typescript-angular-v2/npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/angular2-typescript-petstore@0.0.1 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/@swagger/angular2-typescript-petstore-0.0.1.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
3 changes: 1 addition & 2 deletions samples/client/petstore/typescript-angular-v2/npm/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
"module": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"build": "ngc",
"postinstall": "npm run build"
"build": "ngc && npm pack"
},
"peerDependencies": {
"@angular/core": "^2.0.0",
Expand Down
4 changes: 3 additions & 1 deletion samples/client/petstore/typescript-angular-v2/with-interfaces/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion samples/client/petstore/typescript-angular-v4.3/npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/angular2-typescript-petstore@0.0.1 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE/dist:
Expand Down
4 changes: 3 additions & 1 deletion samples/client/petstore/typescript-angular-v4/npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/angular2-typescript-petstore@0.0.1 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE/dist:
Expand Down
4 changes: 3 additions & 1 deletion ...nt/petstore/typescript-angular-v6-not-provided-in-root/builds/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion ...t/petstore/typescript-angular-v6-not-provided-in-root/builds/with-npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE/dist:
Expand Down
4 changes: 3 additions & 1 deletion ...client/petstore/typescript-angular-v6-provided-in-root/builds/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion ...lient/petstore/typescript-angular-v6-provided-in-root/builds/with-npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE/dist:
Expand Down
4 changes: 3 additions & 1 deletion ...nt/petstore/typescript-angular-v7-not-provided-in-root/builds/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion ...t/petstore/typescript-angular-v7-not-provided-in-root/builds/with-npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE/dist:
Expand Down
4 changes: 3 additions & 1 deletion ...client/petstore/typescript-angular-v7-provided-in-root/builds/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE:
Expand Down
4 changes: 3 additions & 1 deletion ...lient/petstore/typescript-angular-v7-provided-in-root/builds/with-npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using `npm link`:_

In PATH_TO_GENERATED_PACKAGE/dist:
Expand Down

0 comments on commit 019cde7

Please sign in to comment.