README
@acaisoft/auth
A shared lib containing various utils and React components that allow managing authorization flow and state in a single place.
Bootstrapped with typescript-library-starter
Features
- Zero-setup. After running
npm install
things will setup for you :wink: - RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
- Tests, coverage and interactive watch mode using Jest
- Prettier and TSLint for code formatting and consistency
- Docs automatic generation and deployment to
gh-pages
, using TypeDoc - Automatic types
(*.d.ts)
file generation
Importing library
You can import the generated bundle to use the whole library generated by this starter:
import { ... } from '@acaisoft/auth'
Additionally, you can import the transpiled modules from dist/lib
in case you have a modular library:
import something from '@acaisoft/auth/dist/lib/something'
NPM scripts
yarn start
: Runyarn build
in watch modeyarn test
: Run test suiteyarn test:watch
: Run test suite in interactive watch modeyarn test:prod
: Run linting and generate coverageyarn build
: Generate bundles and typings, create docsyarn lint
: Lints code
Excluding peerDependencies
On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.
Good news: the setup is here for you, you must only include the dependency name in external
property within rollup.config.js
. For example, if you want to exclude lodash
, just write there external: ['lodash']
.