Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time

How to maintain this package

This document has been created along with the project through the elm-review new-package command.

A lot of things should happen automatically for you. Here is an overview of what you should know and what to expect.

We'll discuss

This document and the set up created for you is aimed at helping you work and improving the quality of the package. You can however opt out of all of this if you encounter problems or it doesn't suit you for any reason. If that happens, please contact the elm-review maintainers so that they can work on improvements.

After creation

Right after you have created the package, you should

1. Install the npm dependencies

npm install

If you prefer using yarn or another package manager, you can do so, but you should update the 2 "Install npm dependencies" scripts in .github/workflows/test.yml so that they use your preferred package manager.

Note that elm-tooling takes care of some of the Elm dependencies, notably elm and elm-format. Their versions are defined in the elm-tooling.json file, and are automatically installed through the postinstall script/hook in package.json.

2. Set up Git

git init
git add --all
git commit --message="Initialize project"

3. Replace REPLACEME

In some of the files, notably elm.json, and the rule files that were created for you, you will find a few REPLACEME. You will need to replace all of these and by things that make sense in their individual context.

Again, you can do this step at a later time if you prefer, but you will have to do these before publishing. You will be reminded to do this when running the tests.

Note that you will also have to supply the summary field in the elm.json, which should be close to the same thing that you will write in the README.

4. (Can be done later) Create the project on GitHub

You can do this step at a later time if you prefer. When you do, consider to

Writing rules

You can read how to use elm-review's API to write a rule here.

I highly recommend writing rules in a test-driven manner (TDD), because the tests you write will dramatically increase the quality of the rule, and because they will make the development quite easy. You can read more about it here.

If you want to preview the documentation of the package, you can run npm run preview-docs, which will run a local version of elm-doc-preview. If you see docs.json in your project, please commit it. This will allow you to share the latest version of the docs with collaborators using the online version of elm-doc-preview.

Adding a new rule

It is better if rule packages contain multiple rules dealing with the same or similar concerns, rather than a single rule. Therefore, you will likely add a new rule to the package at one point.

To do so, I recommend using the elm-review new-rule command. This will prompt you for the name of the rule, and then create a source file and a test file, and update the elm.json and the, and insert the rule into the preview configurations.

Example and preview configurations

In the rules generated by new-package and new-rule, and also in the README, you will see a section named "Try it out" which recommends using a command that looks like this:

elm-review --template <author>/<package name>/example --rules <rule name>

This enables people to run the rule without having to set up elm-review, add your package as a dependency, add the rules to their configuration and then run it. This is an easy way to try out the rules and see if they can be useful to them. In order for this to work, you will need to do a little bit of work, but this will be useful to you too!

There are two folders that will exist in your folder that will help make this work, preview/ and example/. Both are review configurations and they serve similar purposes.

  • example/ is the configuration that works with the last released version (as a dependency). It should not change in a way that would not work with the latest released version (no unpublished rules, no new arguments, etc.). Examples in the documentation will use this configuration, which is why it should remain stable.
  • preview/ is the configuration that works with the current version of the source code (as a source directory). It can change however/whenever you see fit. You can use this configuration to let users/testers try out new rules or bug fixes to published rules before releasing a new version.

When the project gets created, you will only have a preview/ folder. You will create example/ (automatically) when you are ready to publish the initial release, using node maintenance/update-examples-from-preview.js which will copy the contents of the preview/ configuration and adapt it to use the package as a dependency instead of source directories. Before every release, you will have to run this same command, otherwise tests in the CI will fail when attempting to publish the package. You should ideally not change example yourself, and instead consider preview/ as the source of truth.

In practice, you are not limited to a single example and a single preview configuration. You can add new configurations and name them however you want. The pre-made scripts will look for any project (containing an elm.json at its root) in directories and sub-directories whose name start with preview. You can therefore have preview/with-configuration-A/ and preview/with-configuration-B/, or preview-with-configuration-A/ and preview-with-configuration-B/. When creating the example configurations from these, their names will be the same, except that "preview" in their names will be changed to "example".


Initial release

The initial release has to be done manually. I recommend running the following script:

# Make sure your tests pass. Fix them if necessary
npm test

# Generate the example configurations
node maintenance/update-examples-from-preview.js
git add --all
git commit --message '1.0.0'

# Commit
git tag 1.0.0
git push --tags origin $(git_main_branch)
elm publish

Successive releases

Contrary to the initial release, the CI will automatically try to publish a new version of the package when the version in the elm.json is bumped. There is no need to add the Git tag or to run elm publish yourself! More details here.

Here is a script that you can run to publish your package, which will help you avoid errors showing up at the CI stage.

npm run elm-bump

# Commit it all
git add --all
git commit # You'll need to specify a message
git push origin HEAD

# Now wait for CI to finish and check that it succeeded