eslint-plugin-propeller

eslint-plugin-propeller

Installation

yarn add @propelleraero/eslint-plugin-propeller

Testing

Tests are run using jest. Test files can be found in the test folder. To run them:

yarn test

A pre-push hook is installed via husky that runs the tests before each git push to help prevent broken code from being pushed. To skip this step add --no-verify to your git command.

Code styling

Prettier is installed and run on each commit via pre-commit hook to ensure consistency in code styling. You can alter the settings for prettier in the .prettierrc file.

You can set up your editor to run prettier on save for more instant feedback.

Linting is also performed pre-commit using eslint with the AirBnB config as a base. You can edit the linting rules in .eslintrc.

Deployment

Deployment is performed in CI (Codeship) when changes are pushed to the beta and main branches by running the publish-javascript-package command from deploy-tools. This publishes the repository to NPM under the name @propelleraero/eslint-plugin-propeller. Pushing to the beta branch will publish a new pre-release beta version on each push. Pushing to the main branch will publish a new version when the version number in package.json is changed. We follow SemVer for all our versioning.

Codeship

Codeship is used for CI and works based on docker containers. The pipeline is defined in the codeship-steps.yml and codeship-services.yml files. All other deployment related files live in the deployment folder. You can run the pipeline locally with yarn codeship:local. See here for more advanced options when running locally.

Deployment secrets

Codeship secrets are stored in encrypted files in the deployment/secrets/encrypted folder. To chage them, first make sure you have the jet cli installed and a codeship.aes file in your root folder. You can download the codeship.aes file from the codeship web app.

Decrypt the secrets by running yarn codeship:decrypt. Make your changes to the unencrypted files in deployment/secrets/unencrypted and encrypt them again with yarn codeship:encrypt. It is safe to then check in those encrypted files.

DO NOT check in the unencrypted files or codeship.aes. There are .gitignore rules to prevent this.