@equisoft/typescript-config v2.0.0
Kronos Technologies Standards
Supported languages
Kotlin
Located in kotlin.
The plugin is available on the Gradle Plugins Portal: com.equisoft.standards.kotlin
PHP
Located in php/php-coding-standard.
Supports Squizlab's PHP CodeSniffer.
JavaScript (NodeJS)
For use in a NodeJS environment without TypeScript. Located under packages/javascript/eslint-config.
Applied through ESLint.
React flavor
Use the configuration located under packages/javascript/eslint-config-react instead.
TypeScript (NodeJS + Web)
For use in a NodeJS or Web environment with TypeScript. Located under packages/javascript/tslint-config.
Applied through TSLint.
Building & Publishing
PHP (Composer)
Apply your changes, merge in master
branch, then execute the following commands from the root of the directory:
# Mirrors php-coding-standard repository in kronostechnologies/php-coding-standard
bin/split.sh
# Push tag to kronostechnologies/php-coding-standard
bin/release.sh v(MAJOR.MINOR.PATCH)
To get the latest tag without opening the php-coding-standard repository, checkout the file .tag.
Prefer updating minor versions.
Afterwards, it is automatically published through packagist.
NPM
Make sure you are starting from an up to date master branch.
- Create a new branch:
git checkout -b release/1.2.3
- Navigate to the directory of the project you wish to publish
- Update the CHANGELOG.md file to reflect the changes to be published
- If the project has extra steps to run before publication (ie: test, compile, etc.), run them
- Configure your username and email:
yarn login
Publish:
yarn publish
.When asked for the new version, respect semver:
- Majors are for breaking changes. ie: Adding a new linting rule may break projects, so this is a new major.
- Minors are for new features.
- Patches are for bug fixes.
Yarn will automatically create a commit for this new version and tag it appropriately.
If you have 2FA enabled on your account, you must use Yarn >=1.12.
Push your branch and tag:
git push origin HEAD; git push origin tslint-config-1.2.3
- Open a Pull Request on GitHub:
https://github.com/kronostechnologies/standards/compare/master...release/1.2.3