chore(README): add format and lint commands

This commit is contained in:
Cory Dransfeldt 2025-06-14 18:56:28 -07:00
parent a27c18101b
commit fdeec2c176
No known key found for this signature in database
3 changed files with 7 additions and 4 deletions

View file

@ -39,6 +39,9 @@ This will run `eleventy --watch` and the PHP cli concurrently, allowing for an e
- `coryd run php`: starts a PHP server for local development.
- `coryd run build`: builds static site output.
- `coryd run clean`: removes the `dist` and `.cache` folders.
- `coryd run format`: formats JavaScript, JSON, CSS and Markdown files using Prettier, PHP files using Pint and SQL files using sql-formatter.
- `coryd run format:sql`: formats SQL files using sql-formatter.
- `coryd run lint:md`: lints markdown files using Markdown lint.
- `coryd run update`: checks for dependency updates and updates 11ty.
## Required environment variables

4
package-lock.json generated
View file

@ -1,12 +1,12 @@
{
"name": "coryd.dev",
"version": "10.3.5",
"version": "10.3.6",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "coryd.dev",
"version": "10.3.5",
"version": "10.3.6",
"license": "MIT",
"dependencies": {
"minisearch": "^7.1.2",

View file

@ -1,6 +1,6 @@
{
"name": "coryd.dev",
"version": "10.3.5",
"version": "10.3.6",
"description": "The source for my personal site. Built using 11ty (and other tools).",
"type": "module",
"engines": {
@ -13,7 +13,7 @@
"php": "export $(grep -v '^#' .env | xargs) && php -d error_reporting=E_ALL^E_DEPRECATED -S localhost:8080 -t dist",
"build": "eleventy",
"clean": "rimraf dist .cache",
"format": "npx prettier --write '**/*.{js,ts,json,css,md}' && composer format:php && npm run format:sql",
"format": "npx prettier --write '**/*.{js,json,css,md}' && composer format:php && npm run format:sql",
"format:sql": "find queries -name '*.sql' -print0 | xargs -0 -n 1 sql-formatter --language postgresql --fix",
"lint:md": "markdownlint '**/*.md'",
"update": "composer update && npm upgrade && npm --prefix cli upgrade && ncu && ncu --cwd cli",