Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
ngx-stripe
Advanced tools
ngx-stripe - npm Package Compare versions
Comparing version 0.0.1 to 0.0.2
| { | ||
| "name": "ngx-stripe", | ||
| "version": "0.0.1", | ||
| "version": "0.0.2", | ||
| "description": "Angular 2+ wrapper for StripeJS", | ||
@@ -5,0 +5,0 @@ "main": "./bundles/ngx-stripe.umd.js", |
167
README.md
@@ -1,166 +0,1 @@ | ||
| # angular-library-starter | ||
| [](https://travis-ci.org/robisim74/angular-library-starter) | ||
| >Build an Angular library compatible with AoT compilation & Tree shaking. | ||
| This starter allows you to create a library for **Angular 4+** apps written in _TypeScript_, _ES6_ or _ES5_. | ||
| The project is based on the official _Angular_ packages. | ||
| Get the [Changelog](https://github.com/robisim74/angular-library-starter/blob/master/CHANGELOG.md). | ||
| ## Contents | ||
| * [1 Project structure](#1) | ||
| * [2 Customizing](#2) | ||
| * [3 Testing](#3) | ||
| * [4 Building](#4) | ||
| * [5 Publishing](#5) | ||
| * [6 Documentation](#6) | ||
| * [7 Using the library](#7) | ||
| * [8 What it is important to know](#8) | ||
| ## <a name="1"></a>1 Project structure | ||
| - Library: | ||
| - **src** folder for the classes | ||
| - **public_api.ts** entry point for all public APIs of the package | ||
| - **package.json** _npm_ options | ||
| - **rollup.config.js** _Rollup_ configuration for building the bundles | ||
| - **tsconfig-build.json** _ngc_ compiler options for _AoT compilation_ | ||
| - **build.js** building process using _ShellJS_ | ||
| - Testing: | ||
| - **tests** folder for unit & integration tests | ||
| - **karma.conf.js** _Karma_ configuration that uses _webpack_ to build the tests | ||
| - **spec.bundle.js** defines the files used by _webpack_ | ||
| - Extra: | ||
| - **tslint.json** _TypeScript_ linter rules with _Codelyzer_ | ||
| - **travis.yml** _Travis CI_ configuration | ||
| ## <a name="2"></a>2 Customizing | ||
| 1. Update [Node & npm](https://docs.npmjs.com/getting-started/installing-node). | ||
| 2. Rename `angular-library-starter` and `angularLibraryStarter` everywhere to `my-library` and `myLibrary`. | ||
| 3. Update in `package.json` file: | ||
| - version: [Semantic Versioning](http://semver.org/) | ||
| - description | ||
| - urls | ||
| - packages | ||
| and run `npm install`. | ||
| 4. Create your classes in `src` folder, and export public classes in `my-library.ts`. | ||
| 5. You can create only one _module_ for the whole library: | ||
| I suggest you create different _modules_ for different functions, | ||
| so that the user can import only those he needs and optimize _Tree shaking_ of his app. | ||
| 6. Update in `rollup.config.js` file `globals` external dependencies with those that actually you use. | ||
| 7. Create unit & integration tests in `tests` folder, or unit tests next to the things they test in `src` folder, always using `.spec.ts` extension. | ||
| _Karma_ is configured to use _webpack_ only for `*.ts` files: if you need to test different formats, you have to update it. | ||
| ## <a name="3"></a>3 Testing | ||
| The following command run unit & integration tests that are in the `tests` folder, and unit tests that are in `src` folder: | ||
| ```Shell | ||
| npm test | ||
| ``` | ||
| ## <a name="4"></a>4 Building | ||
| The following command: | ||
| ```Shell | ||
| npm run build | ||
| ``` | ||
| - starts _TSLint_ with _Codelyzer_ | ||
| - starts _AoT compilation_ using _ngc_ compiler | ||
| - creates `dist` folder with all the files of distribution | ||
| To test locally the npm package: | ||
| ```Shell | ||
| npm run pack-lib | ||
| ``` | ||
| Then you can install it in an app to test it: | ||
| ```Shell | ||
| npm install [path]my-library-[version].tgz | ||
| ``` | ||
| ## <a name="5"></a>5 Publishing | ||
| Before publishing the first time: | ||
| - you can register your library on [Travis CI](https://travis-ci.org/): you have already configured `.travis.yml` file | ||
| - you must have a user on the _npm_ registry: [Publishing npm packages](https://docs.npmjs.com/getting-started/publishing-npm-packages) | ||
| ```Shell | ||
| npm run publish-lib | ||
| ``` | ||
| ## <a name="6"></a>6 Documentation | ||
| To generate the documentation, this starter uses [compodoc](https://github.com/compodoc/compodoc): | ||
| ```Shell | ||
| npm run compodoc | ||
| npm run compodoc-serve | ||
| ``` | ||
| ## <a name="7"></a>7 Using the library | ||
| ### Installing | ||
| ```Shell | ||
| npm install my-library --save | ||
| ``` | ||
| ### Loading | ||
| #### Using SystemJS configuration | ||
| ```JavaScript | ||
| System.config({ | ||
| map: { | ||
| 'my-library': 'node_modules/my-library/bundles/my-library.umd.js' | ||
| } | ||
| }); | ||
| ``` | ||
| #### Angular-CLI | ||
| No need to set up anything, just import it in your code. | ||
| #### Rollup or webpack | ||
| No need to set up anything, just import it in your code. | ||
| #### Plain JavaScript | ||
| Include the `umd` bundle in your `index.html`: | ||
| ```Html | ||
| <script src="node_modules/my-library/bundles/my-library.umd.js"></script> | ||
| ``` | ||
| and use global `ng.myLibrary` namespace. | ||
| ### AoT compilation | ||
| The library is compatible with _AoT compilation_. | ||
| ## <a name="8"></a>8 What it is important to know | ||
| 1. `package.json` | ||
| * `"main": "./bundles/angular-library-starter.umd.js"` legacy module format | ||
| * `"module": "./bundles/angular-library-starter.es5.js"` flat _ES_ module, for using module bundlers such as _Rollup_ or _webpack_: | ||
| [package module](https://github.com/rollup/rollup/wiki/pkg.module) | ||
| * `"es2015": "./bundles/angular-library-starter.js"` _ES2015_ flat _ESM_ format, experimental _ES2015_ build | ||
| * `"peerDependencies"` the packages and their versions required by the library when it will be installed | ||
| 2. `tsconfig.json` file used by _TypeScript_ compiler | ||
| * Compiler options: | ||
| * `"strict": true` enables _TypeScript_ `strict` master option | ||
| 3. `tsconfig-build.json` file used by _ngc_ compiler | ||
| * Compiler options: | ||
| * `"declaration": true` to emit _TypeScript_ declaration files | ||
| * `"module": "es2015"` & `"target": "es2015"` are used by _Rollup_ to create the _ES2015_ bundle | ||
| * Angular Compiler Options: | ||
| * `"skipTemplateCodegen": true,` skips generating _AoT_ files | ||
| * `"annotateForClosureCompiler": true` for compatibility with _Google Closure compiler_ | ||
| * `"strictMetadataEmit": true` without emitting metadata files, the library will not compatible with _AoT compilation_ | ||
| 4. `rollup.config.js` file used by _Rollup_ | ||
| * `format: 'umd'` the _Universal Module Definition_ pattern is used by _Angular_ for its bundles | ||
| * `moduleName: 'ng.angularLibraryStarter'` defines the global namespace used by _JavaScript_ apps | ||
| * `external` & `globals` declare the external packages | ||
| 5. Server-side prerendering | ||
| If you want the library will be compatible with server-side prerendering: | ||
| * `window`, `document`, `navigator` and other browser types do not exist on the server | ||
| * don't manipulate the _nativeElement_ directly | ||
| ## License | ||
| MIT | ||
| # ngx-stripe |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-4.51%
131605
- Number of lines in readme file
- decreased by-98.8%
2
No dependency changes