From 23492961d58b85b841982cb13755837ff67e663f Mon Sep 17 00:00:00 2001 From: Kieran Date: Wed, 7 Aug 2024 15:38:06 -0700 Subject: [PATCH] [Dev] Adds `.devcontainer` manifest to help promote contributions (#342) * Added a devcontainer file * linting * Added link to README --- .devcontainer/devcontainer.json | 12 ++++++++++++ .prettierignore | 1 + tooling/.prettierrc.js => .prettierrc.js | 0 README.md | 1 + docker-compose.yml | 2 -- package.json | 4 ++-- tooling/.prettierignore | 1 - 7 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 .devcontainer/devcontainer.json create mode 100644 .prettierignore rename tooling/.prettierrc.js => .prettierrc.js (100%) delete mode 100644 tooling/.prettierignore diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..ff42f7d --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,12 @@ +{ + "name": "Pinchflat Dev", + "dockerComposeFile": "../docker-compose.yml", + "service": "phx", + "workspaceFolder": "/app", + "shutdownAction": "stopCompose", + "customizations": { + "vscode": { + "extensions": ["phoenixframework.phoenix", "JakeBecker.elixir-ls", "esbenp.prettier-vscode"] + } + } +} diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..bdc7a23 --- /dev/null +++ b/.prettierignore @@ -0,0 +1 @@ +assets/vendor/ diff --git a/tooling/.prettierrc.js b/.prettierrc.js similarity index 100% rename from tooling/.prettierrc.js rename to .prettierrc.js diff --git a/README.md b/README.md index a550c87..1f03132 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ [![](https://img.shields.io/github/license/kieraneglin/pinchflat?style=for-the-badge&color=ee512b)](LICENSE) [![](https://img.shields.io/github/v/release/kieraneglin/pinchflat?style=for-the-badge)](https://github.com/kieraneglin/pinchflat/releases) [![](https://img.shields.io/github/actions/workflow/status/kieraneglin/pinchflat/lint_and_test.yml?style=for-the-badge)](#) +[![](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode&style=for-the-badge)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/kieraneglin/pinchflat) diff --git a/docker-compose.yml b/docker-compose.yml index aad86e8..e193a16 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -10,5 +10,3 @@ services: command: bash -c "chmod +x docker/docker-run.dev.sh && docker/docker-run.dev.sh" stdin_open: true tty: true - env_file: - - .env diff --git a/package.json b/package.json index fab6aa5..05dfe91 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,8 @@ }, "scripts": { "create-erd": "sqleton -o priv/repo/erd.png priv/repo/pinchflat_dev.db", - "lint:check": "prettier . --check --config=tooling/.prettierrc.js --ignore-path=tooling/.prettierignore --ignore-path=.gitignore", - "lint:fix": "prettier . --write --config=tooling/.prettierrc.js --ignore-path=tooling/.prettierignore --ignore-path=.gitignore" + "lint:check": "prettier . --check --config=.prettierrc.js --ignore-path=.prettierignore --ignore-path=.gitignore", + "lint:fix": "prettier . --write --config=.prettierrc.js --ignore-path=.prettierignore --ignore-path=.gitignore" }, "private": true } diff --git a/tooling/.prettierignore b/tooling/.prettierignore deleted file mode 100644 index 937ae7c..0000000 --- a/tooling/.prettierignore +++ /dev/null @@ -1 +0,0 @@ -../assets/vendor/