@acaisoft/auth

Auth tools and utils

Usage no npm install needed!

<script type="module">
  import acaisoftAuth from 'https://cdn.skypack.dev/@acaisoft/auth';
</script>

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: Run yarn build in watch mode
  • yarn test: Run test suite
  • yarn test:watch: Run test suite in interactive watch mode
  • yarn test:prod: Run linting and generate coverage
  • yarn build: Generate bundles and typings, create docs
  • yarn 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'].