mirror of https://github.com/ivuorinen/dotfiles.git synced 2026-01-26 11:14:08 +00:00

Files

Ismo Vuorinen 5f59851c7a chore(tooling): use yarn for linting scripts (#149 )

* chore(tooling): use yarn for linting scripts

* chore: fixes and tweaks

* chore(ci): more permissions

* chore: clean up, lint fixes

* chore: clean up, lint fixes

* chore: clean up, lint fixes

* chore(lint): fix yamllint errors and warnings

* chore(lint): lint fixes

* chore(lint): lint fixes

2025-08-15 09:06:22 +03:00

1.4 KiB

Raw Blame History

Project guidelines

This repository contains configuration files and helper scripts for managing a development environment. Dotbot drives installation, and host-specific folders under hosts/ contain extra configs.

Setup

Run yarn install to fetch linting tools and the Bats test framework.
Re-run yarn install whenever package.json changes.
Yarn is the package manager of choice; avoid npm commands.

Keeping the repository up to date

Update submodules with git submodule update --remote --merge.
Pull the latest changes and run ./install.

Linting and tests

Format files with:
```
yarn fix:prettier
yarn fix:markdown
```

Shell scripts must pass shellcheck.

find . -path ./node_modules -prune -o -name '*.sh' -print0 | xargs -0 shellcheck

Ensure .editorconfig rules pass:
```
tools/install-ec.sh
ec
```
Execute tests with yarn test when code changes.

Debugging lint issues

yarn lint:prettier and yarn lint:markdown show formatting errors.
Ensure shell scripts have a shebang or # shellcheck shell=bash directive.
Consult .shellcheckrc for project specific checks.

Scripts rely on helpers in config/shared.sh so they run under Bash, Zsh and Fish by default.

Commits and PRs

Use Semantic Commit messages: type(scope): summary.
Keep PR titles in the same format.

1.4 KiB Raw Blame History