0.0.23 • Published 7 years ago
ui-fenix-kit-core v0.0.23
UI Fenix Kit - Core
UI Fenix Kit Core
Before you enter to the jungle :P!
- How to make a changelog: standard-version
- Test System: Jest
- Documentation (yes!, yo need to doc your components!): Markdown
- Tips for rookies!: Tsmean
What does it include:
- exported class as example for an npm moudle
- packaging for npm modules (webpack + tslint + awesome-typescript-loader + dts-bundle)
- testings for npm modules (jest)
- code coverage (jest) when running tests
- Typescript => ES5
- Two versions embed in the package, one for node, one for browser (browserify)
Notes
Please note that you will need to rename the library name in some files:
1. webpack.config.js (bundle_opts)
2. package.json (ofcourse ;))
Also don't forget to reset package version ;)
Useful commands:
npm install - install NPM dependancies
npm run build - build the library files
npm run test - run the tests
npm run test:watch - run the tests (watch-mode)
npm run coverage - run the tests with coverage
npm run coverage:watch - run the tests with coverage (watch-mode)
npm run prepare - build the library, make sure the tests passes, and then pack the library (creates .tgz)
npm run release - prepare package for next release
Files explained:
1. src - directory is used for typescript code that is part of the project
1a. src/Example.ts - Just an example exported library, used to should import in tests.
1b. test/Example.test.ts - tests for the example class
1c. src/index.ts - index, which functionality is exported from the library
3. package.json - file is used to describe the library
4. tsconfig.json - configuration file for the library compilation
6. tslint.json - configuration file for the linter (both test and library)
8. webpack.config.js - configuration file of the compilation automation process for the library
Output files explained:
- node_modules - directory npm creates with all the dependencies of the module (result of npm install)
- dist - directory contains the compiled library (javascript + typings)
- coverage - code coverage report output made by istanbul