cryptid-org/cryptid-js

Browser-friendly Identity-based Encryption library powered by WebAssembly.

cryptid-js's Issues

Migrate to pnpm

Brief

cryptid-js is currently managed by the default Node package manager, npm. However, there is a much better solution for this task, pnpm (https://github.com/pnpm/pnpm).

Task

• Replace the package lock file with a pnpm lock file (ie. install with pnpm).
• Update the dependency and devDependency versions.

Public API typings

Brief

The public API lacks proper typing making it hard to consume by clients.

Task

Introduce typings or TypeScript in the public API.

Introduce commit message linting

Brief

Once you start linting your code, there's no way back: you want to lint everything! For example, commit messages. Enforcing format and structure in commit messages allows for automatic semver bumps, changelog generation, repository analytics and also looks good. See https://www.conventionalcommits.org/en/v1.0.0/

Because cryptid-js lacks this facility, we should definitely add commitlinting.

Task

• Add commit message linting using https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional and https://github.com/typicode/husky

Introduce eslint and prettier

Brief

Currently, cryptid-js has absolutely no linting or formatting rules: you can freely write code any way you want, commit it and push it. No restrictions, no checks. You can use tabs in one file and spaces in another (the horror! 😢).

To improve upon this situation, we should set up a linting and formatting toolchain using eslint (https://eslint.org/) and prettier (https://prettier.io/).

Task

• Create the lint and lint:fix scripts in the package.json.
  • Obviously, lint:fix should run the linter with the --fix flag.
• Configure eslint and prettier.
  • Please use separeate files, do not pollute the package.json with this configuration.
  • Please be aware, that cryptid-js is isomorphic: clients can use it on both the client-side and the server-side. The linting configuration should be aware of this scenario.

Settings for Prettier

Please use the following settings for prettier:

{
    "singleQuote": true,
    "printWidth": 120,
    "semi": false
}

GitHub Actions workflow on push

Brief

As a bigger goal, we want a nice Continuous Delivery pipeline for cryptid-js. However, even the greatest journey starts with a single step, so for a starter, let's implement a Continuous Integration workflow.

Task

Create a new GitHub Actions workflow that

• runs on
  • push to master
  • PR to master
• executes the lint script and fails if the codebase is not properly linted/formatted.

Dependencies

Depends on #7