Skip to content

Commit 1d94efa

Browse files
committed
Use lerna for managing the project and provide separate README for NPM
- Add lerna support for managing the project - Move src into sub-directory tsp-typescript-client - Update package.json files - Add README.md for NPM. Fixes #34 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
1 parent ee6165e commit 1d94efa

33 files changed

+3905
-101
lines changed

.gitignore

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LC_COLLATE=C sort
22
/*.log
33
/.DS_Store
4-
/coverage/
5-
/lib/
6-
/node_modules/
4+
coverage
5+
lib
6+
node_modules

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2019 Ericsson and others
1+
Copyright (c) 2019, 2021 Ericsson and others
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

lerna.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"lerna": "4.0.0",
3+
"version": "0.3.0",
4+
"useWorkspaces": true,
5+
"npmClient": "yarn",
6+
"command": {
7+
"run": {
8+
"stream": true
9+
}
10+
}
11+
}

package.json

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
{
2-
"name": "tsp-typescript-client",
32
"version": "0.3.0",
4-
"description": "Trace Server Protocol client written in TypeScript",
5-
"author": "Ericsson and others",
3+
"private": "true",
64
"license": "MIT",
7-
"main": "lib/index.js",
8-
"typings": "lib/index.d.ts",
9-
"publishConfig": {
10-
"access": "public"
11-
},
125
"keywords": [
136
"tsp",
147
"trace server protocol",
@@ -28,23 +21,21 @@
2821
"src"
2922
],
3023
"devDependencies": {
31-
"@types/jest": "^27.0.1",
32-
"@types/node": "^11.13.8",
33-
"@types/node-fetch": "^2.3.3",
34-
"jest": "^27.1.0",
35-
"ts-jest": "^27.0.5",
36-
"ts-node": "^8.1.0",
37-
"tslint": "^5.16.0",
38-
"tslint-language-service": "^0.9.9",
24+
"lerna": "4.0.0",
3925
"typescript": "latest"
4026
},
4127
"dependencies": {
4228
"node-fetch": "^2.5.0"
4329
},
30+
"workspaces": [
31+
"tsp-typescript-client"
32+
],
4433
"scripts": {
4534
"prepare": "yarn build",
46-
"build": "tsc",
47-
"publish:next": "yarn publish --new-version \"$(semver $npm_package_version -i minor)-next.$(git rev-parse --short HEAD)\" --tag next --no-git-tag-version --no-commit-hooks",
48-
"test": "jest --config jest.config.json"
35+
"build": "lerna run build",
36+
"clean": "lerna run clean",
37+
"test": "lerna run test --",
38+
"publish:latest": "lerna publish --registry=https://registry.npmjs.org/ --exact --no-git-tag-version --no-push",
39+
"publish:next": "lerna publish --registry=https://registry.npmjs.org/ --exact --canary minor --preid=next.$(git rev-parse --short HEAD) --dist-tag=next --no-git-tag-version --no-push --yes"
4940
}
5041
}

tsp-typescript-client/LICENSE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2019, 2021 Ericsson and others
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
14+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
17+
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
18+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
19+
OR OTHER DEALINGS IN THE SOFTWARE.

tsp-typescript-client/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Description
2+
3+
A client-side implementation, in typescript, of the Trace Server Protocol (TSP).
4+
5+
## Additional Information
6+
7+
- [Trace Server Protocol (TSP)](https://github.com/theia-ide/theia-trace-extension): Protocol specification.
8+
- [Theia Trace Extension](https://github.com/theia-ide/theia-trace-extension): An reference application that uses the tsp-typescript-client to communicate to a trace-server back-end.
9+
File renamed without changes.

tsp-typescript-client/package.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "tsp-typescript-client",
3+
"version": "0.3.0",
4+
"description": "Trace Server Protocol client written in TypeScript",
5+
"author": "Ericsson and others",
6+
"license": "MIT",
7+
"main": "lib/index.js",
8+
"typings": "lib/index.d.ts",
9+
"publishConfig": {
10+
"access": "public"
11+
},
12+
"devDependencies": {
13+
"@types/jest": "^27.0.1",
14+
"@types/node": "^11.13.8",
15+
"@types/node-fetch": "^2.3.3",
16+
"jest": "^27.1.0",
17+
"ts-jest": "^27.0.5",
18+
"ts-node": "^8.1.0",
19+
"tslint": "^5.16.0",
20+
"tslint-language-service": "^0.9.9",
21+
"typescript": "latest"
22+
},
23+
"dependencies": {
24+
"node-fetch": "^2.5.0",
25+
"rimraf": "latest"
26+
},
27+
"scripts": {
28+
"prepare": "yarn run clean && yarn run build",
29+
"build": "tsc",
30+
"clean": "rimraf lib",
31+
"test": "jest --config jest.config.json"
32+
}
33+
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)