Skip to content

Commit

Permalink
feat: initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
wkillerud committed Jul 30, 2024
0 parents commit 07d0015
Show file tree
Hide file tree
Showing 13 changed files with 159 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
29 changes: 29 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Publish

on:
push:
branches:
- main
- alpha
- beta
- next

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 20

- run: npm install

- run: npm run lint

- run: npx semantic-release
env:
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
23 changes: 23 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Test

on:
push:
branches-ignore:
- main
- alpha
- beta
- next

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 20

- run: npm install

- run: npm run lint
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
2 changes: 2 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
package-lock=false
save-exact=true
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing

Thank you for showing an interest in contributing to Eik 🧡

This module is a [shared config for prettier](https://prettier.io/docs/en/configuration.html#sharing-configurations). We accept changes that should apply to all repositories in the [eik-lib origanisation](https://github.com/eik-lib).

Commits should follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format.

A change in configuration is considered a `patch` in [semantic versioning](https://semver.org/). A new export would be a `minor`. Depending on a newer version of Prettier would be a `major`.

This repo uses [semantic release](https://github.com/semantic-release/semantic-release) to automate releases whenever changes are merged to the default branch.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# @eik/prettier-config

Shared config for [prettier](https://prettier.io/) used in Eik projects.

## Install

```
npm install --save-dev prettier @eik/prettier-config
```

## Usage

In `prettier.config.js`:

```js
import config from "@eik/prettier-config";

export default config;
```
3 changes: 3 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import config from "@eik/eslint-config";

export default config;
12 changes: 12 additions & 0 deletions lib/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export default {
useTabs: true,
overrides: [
{
files: ["*.yml", "*.json"],
options: {
tabWidth: 2,
useTabs: false,
},
},
],
};
46 changes: 46 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"name": "@eik/prettier-config",
"version": "1.0.0",
"description": "Shared prettier config for Eik modules",
"type": "module",
"exports": {
".": {
"default": "./lib/default.js"
}
},
"files": [
"lib"
],
"repository": {
"type": "git",
"url": "git+ssh://[email protected]/eik-lib/prettier-config.git"
},
"publishConfig": {
"access": "public"
},
"bugs": {
"url": "https://github.com/eik-lib/prettier-config/issues"
},
"homepage": "https://github.com/eik-lib/prettier-config#readme",
"scripts": {
"lint": "eslint .",
"lint:fix": "npm run lint -- --fix",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
"prettier",
"prettierconfig"
],
"author": "",
"license": "MIT",
"peerDependencies": {
"prettier": ">= 3"
},
"devDependencies": {
"@eik/eslint-config": "1.0.0",
"@eik/semantic-release-config": "1.0.0",
"eslint": "9.8.0",
"prettier": "3.3.3",
"semantic-release": "24.0.0"
}
}
3 changes: 3 additions & 0 deletions prettier.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import config from "./lib/config.js";

export default config;
3 changes: 3 additions & 0 deletions release.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default {
extends: "@eik/semantic-release-config",
};
6 changes: 6 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:recommended"
]
}

0 comments on commit 07d0015

Please sign in to comment.