@knapsack-pro/core

@knapsack-pro/core is JS npm package with core features for Knapsack Pro API. Learn how to run your tests faster with optimal test suite parallelisation using Knapsack Pro.

Table of Contents

• FAQ
  • How to change log level?
  • What happens when Knapsack Pro API is not available? How Fallback Mode works?
• Development
  • Setup
  • Publishing

FAQ

How to change log level?

You can set log level with environment variable KNAPSACK_PRO_LOG_LEVEL. The default level is info.

Available log levels (from most important to least important):

• error - shows only critical errors
• warn - shows warnings (e.g. Fallback Mode has started)
• info - shows Knapsack Pro API request response body
• verbose
• debug - shows Knapsack Pro API request headers and body
• silly

What happens when Knapsack Pro API is not available? How Fallback Mode works?

When Knapsack Pro API is not available or temporarily unreachable due to network problems then Fallback Mode will be started and you will see a log warning in the output.

In Fallback Mode your tests will be executed and split based on test file names across CI nodes. If in the meantime other CI nodes were able to connect to Knapsack Pro API then you may notice that some of the test files were executed twice across CI nodes. Fallback Mode guarantees each of test files is run at least once as a part of CI build.

If during CI build runtime connection to Knapsack Pro API is lost, Fallback Mode would run tests except those executed so far.

Development

Setup

1. Install dependencies:

   $ npm install

2. Compile TypeScript code to lib directory by running:

   $ npm start

3. Register @knapsack-pro/core package globally in your local system. This way we will be able to develop other npm packages dependent on it:

   $ npm link

4. Set up your IDE:

   • WebStorm / PhpStorm

     • Install the following plugins:

       • Prettier
       • EditorConfig
       • .ignore

     • Go to File > Settings > Languages & Frameworks > JavaScript > Code Quality Tools > ESLint

       Turn on Enable checkbox.

     • Go to File > Settings > Languages & Frameworks > TypeScript > TSLint

       Turn on Enable checkbox.

     • Go to File > Settings > Tools > File Watchers

       Click Import button and select watchers.xml file from the repository.

   • Visual Studio Code

     • Install the following plugins:

       • Prettier - Code formatter
       • ESLint
       • TypeScript TSLint Plugin
       • EditorConfig for VS Code

     • Go to File > Preferences > Settings > Extensions > Prettier - Code formatter

       Turn on Prettier: Eslint Integration checkbox. Turn on Prettier: Tslint Integration checkbox.

     • Go to File > Preferences > Settings > Text Editor > Formatting

       Turn on Format On Save checkbox.

   From now on every change in code base will be automatically formatted by Prettier. ESLint and TSLint errors will be also automatically fixed on every file save.

5. Write some code.

Publishing

1. Sign in to npm registry with command:

   $ npm adduser

2. Before releasing a new version of package please update CHANGELOG.md with github_changelog_generator:

   $ gem install github_changelog_generator
   
   # generate CHANGELOG.md
   $ github_changelog_generator KnapsackPro/knapsack-pro-core-js
   $ git commit -am "Update CHANGELOG.md"
   $ git push origin master

3. If you have added new files to the repository and they should be part of the released npm package then please ensure they are included in files array in package.json.

4. If you have changed any headers in README.md please refresh table of contents with:

   $ npm run doctoc

5. Compile project:

   $ npm run build

6. In order to bump version of the package run below command. It will also create a version commit and tag for the release:

   # bump patch version 0.0.x
   $ npm version patch
   
   # bump minor version 0.x.0
   $ npm version minor

7. Push to git repository created commit and tag:

   $ git push origin master --tags

8. Now when git tag is on Github you can update CHANGELOG.md again.

   $ github_changelog_generator KnapsackPro/knapsack-pro-core-js
   $ git commit -am "Update CHANGELOG.md"
   $ git push origin master

9. Now you can publish package to npm registry:

   $ npm publish