https://github.com/methodgrab/create-elm-package

An initializer for creating new Elm packages.
https://github.com/methodgrab/create-elm-package

Last synced: 10 months ago
JSON representation

An initializer for creating new Elm packages.

• Host: GitHub
• URL: https://github.com/methodgrab/create-elm-package
• Owner: MethodGrab
• License: isc
• Created: 2022-10-27T21:21:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-20T00:42:40.000Z (over 2 years ago)
• Last Synced: 2025-04-12T03:58:32.171Z (10 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/create-elm-package
• Size: 296 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# create-elm-package

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/MethodGrab/create-elm-package/CI.yaml?branch=main&style=flat-square)](https://github.com/MethodGrab/create-elm-package/actions/workflows/CI.yaml)

[![npm version](https://img.shields.io/npm/v/create-elm-package?style=flat-square)](https://www.npmjs.com/package/create-elm-package)

> An [npm initializer](https://docs.npmjs.com/cli/commands/npm-init) for creating new [Elm](https://elm-lang.org) packages.

## Usage

```

mkdir my-elm-package

cd my-elm-package

npm init elm-package

```

## What's included

Please review the generated code before using it to ensure it meets your needs and doesn't include anything you don't want.

- Basic Elm package boilerplate.

- GitHub [Workflow actions](./templates/base/.github/workflows/CI.yaml) to:

	- Validate the package.

	- Automatically publish new versions using [`elm-publish-action`](https://github.com/dillonkearns/elm-publish-action).  

		Note the initial version 1.0.0 must be published manually.

Note the GitHub workflow assumes your default branch is called `main`. If that's not the case, you should update the following places after you run the initializer:

- The 2 references to `main` at the top of `.github/workflows/CI.yaml`.

- `?branch=main` in the _GitHub Workflow Status_ badge URL in `README.md`.

## Development

1. Clone the repo.

1. `cd create-elm-package`

1. `npm install`

1. `npm run dev`

In a separate session/tab/window:

1. `npm link`

1. `npm init elm-package`  

	This will run the local cloned/linked version.

Instead of running `npm init elm-package` you can run the `create-elm-package` global binary directly.

Instead of linking it with `npm link` and using the global binary you can run the local binary directly: `./dist/cli.js`.