oxygen-lib
Version:
Reusable UI components for <your-app/organization> (oxygen-lib)
125 lines (79 loc) • 2.92 kB
Markdown
# OxygenLib
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.0.
## Code scaffolding
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
```bash
ng generate component component-name
```
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
```bash
ng generate --help
```
## Building
To build the library, run:
```bash
ng build oxygen-lib
```
This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
### Publishing the Library
Once the project is built, you can publish your library by following these steps:
1. Navigate to the `dist` directory:
```bash
cd dist/oxygen-lib
```
2. Run the `npm publish` command to publish your library to the npm registry:
```bash
npm publish
```
## Running unit tests
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
```bash
ng test
```
## Running end-to-end tests
For end-to-end (e2e) testing, run:
```bash
ng e2e
```
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
## Additional Resources
From your workspace root:
# build the library (production config)
ng build oxygen-lib --configuration production
Optionally make a .tgz to test locally:
cd dist/oxygen-lib
npm pack
You can test install into a local consumer app:
cd path/to/consumer-app
npm install ../oxygen-lib/dist/oxygen-lib/oxygen-lib-1.0.0.tgz
# Or use: npm install ../oxygen-lib/dist/oxygen-lib
cd dist/oxygen-lib
# OPTIONAL: test pack
npm pack
# publish
# Create an npm account (if not done)
Sign up at https://www.npmjs.com/
(or use company registry credentials).
Verify email.
Then login locally:npm publish --access public
If your account has 2FA, you will use OTP during login/publish as required.
# make sure version is correct
cd path/to/library-root # where package.json exists (often dist/oxygen-lib)
npm version patch # or minor/major — updates package.json and creates git tag
ng build oxygen-lib --configuration production
cd dist/oxygen-lib
# OPTIONAL: test pack
npm pack
# publish
npm publish --access public
Notes:
Unscoped packages are public by default.
Scoped packages default to private on npm; add --access public to publish publicly.
If you get You cannot publish over previously published versions bump the version (e.g. npm version patch) and rebuild.
npm set registry http://localhost:4873
npm adduser --registry http://localhost:4873
Post-publish: using the package
After publish, in consumer app:
npm install oxygen-lib@1.0.0
# or for scoped
npm install @your-scope/oxygen-lib@1.0.0