Nietzsche's Preposterous Moustache

    @aicore/template-nodejs

    1.0.6 • Public • Published

    template-nodejs

    A template project for nodejs. Has integrated linting, testing, coverage, reporting, GitHub actions for publishing to npm repository, dependency updates and other goodies.

    Easily use this template to quick start a production ready nodejs project template.

    Code Guardian

    <app> build verification

    Sonar code quality check Security rating vulnerabilities Code Coverage Code Bugs Reliability Rating Maintainability Rating Lines of Code Technical debt

    TODOs after template use

    1. Update package.json with your app defaults
    2. Check Build actions on pull requests.
    3. create a home page in wiki by going to wiki link https://github.com/<your_org>/<your_repo>/wiki
    4. In sonar cloud, enable Automatic analysis from Administration Analysis Method for the first time before a pull request is raised: image
    5. Check codacy runs on pull requests, set codacy defaults. You may remove codacy if sonar cloud is only needed.
    6. Update the above Code Guardian badges; change all id=aicore_template-nodejs-ts to the sonar id of your project fields. see this PR: https://github.com/aicore/libcache/pull/13

    Commands available

    Building

    Since this is a pure JS template project, build command just runs test with coverage.

    > npm install   // do this only once.
    > npm run build

    Linting

    To lint the files in the project, run the following command:

    > npm run lint

    To Automatically fix lint errors:

    > npm run lint:fix

    Testing

    To run all tests:

    > npm run test
      Hello world Tests
        ✔ should return Hello World
        #indexOf()
          ✔ should return -1 when the value is not present

    Additionally, to run unit/integration tests only, use the commands:

    > npm run test:unit
    > npm run test:integ

    Coverage Reports

    To run all tests with coverage:

    > npm run cover
      Hello world Tests
        ✔ should return Hello World
        #indexOf()
          ✔ should return -1 when the value is not present
    
    
      2 passing (6ms)
    
    ----------|---------|----------|---------|---------|-------------------
    File      | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
    ----------|---------|----------|---------|---------|-------------------
    All files |     100 |      100 |     100 |     100 |                   
     index.js |     100 |      100 |     100 |     100 |                   
    ----------|---------|----------|---------|---------|-------------------
    
    =============================== Coverage summary ===============================
    Statements   : 100% ( 5/5 )
    Branches     : 100% ( 2/2 )
    Functions    : 100% ( 1/1 )
    Lines        : 100% ( 5/5 )
    ================================================================================
    Detailed unit test coverage report: file:///template-nodejs/coverage-unit/index.html
    Detailed integration test coverage report: file:///template-nodejs/coverage-integration/index.html

    After running coverage, detailed reports can be found in the coverage folder listed in the output of coverage command. Open the file in browser to view detailed reports.

    To run unit/integration tests only with coverage

    > npm run cover:unit
    > npm run cover:integ

    Sample coverage report: image

    Unit and Integration coverage configs

    Unit and integration test coverage settings can be updated by configs .nycrc.unit.json and .nycrc.integration.json.

    See https://github.com/istanbuljs/nyc for config options.

    Publishing packages to NPM

    Preparing for release

    Please run npm run release on the main branch and push the changes to main. The release command will bump the npm version.

    !NB: NPM publish will faill if there is another release with the same version.

    Publishing

    To publish a package to npm, push contents to npm branch in this repository.

    Publishing @aicore/package*

    If you are looking to publish to package owned by core.ai, you will need access to the GitHub Organization secret NPM_TOKEN.

    For repos managed by aicore org in GitHub, Please contact your Admin to get access to core.ai's NPM tokens.

    Publishing to your own npm account

    Alternatively, if you want to publish the package to your own npm account, please follow these docs:

    1. Create an automation access token by following this link.
    2. Add NPM_TOKEN to your repository secret by following this link

    To edit the publishing workflow, please see file: .github/workflows/npm-publish.yml

    Dependency updates

    We use Rennovate for dependency updates: https://blog.logrocket.com/renovate-dependency-updates-on-steroids/

    Code Guardian

    Several automated workflows that check code integrity are integrated into this template. These include:

    1. GitHub actions that runs build/test/coverage flows when a contributor raises a pull request
    2. Sonar cloud integration using .sonarcloud.properties
      1. In sonar cloud, enable Automatic analysis from Administration Analysis Method for the first time image

    IDE setup

    SonarLint is currently available as a free plugin for jetbrains, eclipse, vscode and visual studio IDEs. Use sonarLint plugin for webstorm or any of the available IDEs from this link before raising a pull request: https://www.sonarlint.org/ .

    SonarLint static code analysis checker is not yet available as a Brackets extension.

    Internals

    Testing framework: Mocha , assertion style: chai

    See https://mochajs.org/#getting-started on how to write tests Use chai for BDD style assertions (expect, should etc..). See move here: https://www.chaijs.com/guide/styles/#expect

    Mocks and spies:

    Since it is not that straight forward to mock es6 module imports, use the follow pull request as reference to mock imported libs:

    using sinon lib if the above method doesn't fit your case

    if you want to mock/spy on fn() for unit tests, use sinon. refer docs: https://sinonjs.org/

    Note on coverage suite used here:

    we use c8 for coverage https://github.com/bcoe/c8. Its reporting is based on nyc, so detailed docs can be found here: https://github.com/istanbuljs/nyc ; We didn't use nyc as it do not yet have ES module support see: https://github.com/digitalbazaar/bedrock-test/issues/16 . c8 is drop replacement for nyc coverage reporting tool

    Install

    npm i @aicore/template-nodejs

    DownloadsWeekly Downloads

    4

    Version

    1.0.6

    License

    AGPL-3.0-or-later

    Unpacked Size

    47.1 kB

    Total Files

    4

    Last publish

    Collaborators

    • arunbose
    • ushmajit
    • core.ai