Skip to content

Commit

Permalink
TSU: publish, + package links to main README
Browse files Browse the repository at this point in the history
  • Loading branch information
R-Mielamud committed Nov 13, 2022
1 parent 7bbf106 commit 9723f80
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 52 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ TS United helps one TypeScript project (folder containing a `tsconfig.json` file

Sounds great? **Choose the edition that you need:**

- **@ts-united/node** - compatible with NodeJS runtimes (e.g. NodeJS, Mocha testing framework). Handles both running and building your code.
- **@ts-united/webpack** - compatible with Webpack and frontend frameworks that use it (e.g. Angular, Vue).
- **@ts-united/cra** - is a wrapper for Webpack edition, which allows you to use it in Create React App projects without ejecting.
- **@ts-united/metro** - compatible with Metro bundler, which is used in React Native projects.
- [**@ts-united/node**](https://www.npmjs.com/package/@ts-united/node) - compatible with NodeJS runtimes (e.g. NodeJS, Mocha testing framework). Handles both running and building your code.
- [**@ts-united/webpack**](https://www.npmjs.com/package/@ts-united/webpack) - compatible with Webpack and frontend frameworks that use it (e.g. Angular, Vue).
- [**@ts-united/cra**](https://www.npmjs.com/package/@ts-united/cra) - is a wrapper for Webpack edition, which allows you to use it in Create React App projects without ejecting.
- [**@ts-united/metro**](https://www.npmjs.com/package/@ts-united/metro) - compatible with Metro bundler, which is used in React Native projects.

If you need some good usage examples, check out the [example](https://github.com/R-Mielamud/TsUnited/tree/main/example) folder
12 changes: 6 additions & 6 deletions example/backend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 18 additions & 15 deletions example/cra-frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion example/mocha-tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ This project uses NodeJS runtime and **@ts-united/node**. Also it shows the case

Try to run the tests using `npm test` command.

The tests will import the server instance from backend project (in [./src/specs/todo.spec.ts](https://github.com/R-Mielamud/TsUnited/blob/main/example/mocha-tests/src/specs/todo.spec.ts) file), start it on any free port, run the tests and stop the server. You don't need to start the server in a separate process! Isn't this cool? It makes CI workflows a lot simplier!
The tests will import the server instance from backend project (in [./src/specs/todo.spec.ts](https://github.com/R-Mielamud/TsUnited/blob/main/example/mocha-tests/src/specs/todo.spec.ts) file), start it on any free port, run the tests and stop the server. You don't need to start the server in a separate process! Isn't this cool? It makes CI workflows a lot simplier and faster!

Now let's see how does it work. Comments in the [ts-united.config.js](https://github.com/R-Mielamud/TsUnited/blob/main/example/mocha-tests/ts-united.config.js) explain every config option. In [mocha.config.js](https://github.com/R-Mielamud/TsUnited/blob/main/example/mocha-tests/mocha.config.js) file we tell mocha to import `@ts-united/node/register` module, which automatically registers TS United services when imported (see comments in the [mocha.config.js](https://github.com/R-Mielamud/TsUnited/blob/main/example/mocha-tests/mocha.config.js) file).
12 changes: 6 additions & 6 deletions example/mocha-tests/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions example/react-native-mobile/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 13 additions & 8 deletions example/webpack-frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions packages/cra/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9723f80

Please sign in to comment.