diff --git a/README.md b/README.md index 06a39a7..51640ea 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # typescript A collection of lint, format, and build configs used at Fauna for TypeScript projects. + +## Included configs (`./config/`) +- `eslint.config.js`, a minimal placeholder eslint config. +- `.gitignore`, a minimal placeholder .gitignore file. diff --git a/config/.gitignore b/config/.gitignore deleted file mode 120000 index 3e4e48b..0000000 --- a/config/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.gitignore \ No newline at end of file diff --git a/config/.gitignore b/config/.gitignore new file mode 100644 index 0000000..eac4fc4 --- /dev/null +++ b/config/.gitignore @@ -0,0 +1,5 @@ +# DO NOT EDIT THIS FILE AT $PROJECT_ROOT/.gitignore +# instead, edit it at $PROJECT_ROOT/config/.gitignore +# the project's build step copies it from /config + +node_modules diff --git a/package.json b/package.json index f5dd7e7..6c2a3eb 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", + "build": "cp ./config/.gitignore .gitignore", "bump": "node ./scripts/version-bump.js" }, "files": [