Skip to content

Commit

Permalink
License, readme and publish workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Maximilian Hammerl committed Jan 22, 2025
1 parent e1f26ca commit 1a0ab0f
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 2 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Publish

on:
push:
branches:
- main

jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write # The OIDC ID token is used for authentication with JSR.
steps:
- uses: actions/checkout@v4
- run: npx jsr publish
20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
MIT License

Copyright (c) 2025 Maximilian Hammerl

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# deno-project-config-check

`deno-project-config-check` is a command-line tool designed to help you identify and remove unused imports of your Deno projects.

## Usage

To run the CLI tool:

```
deno run --allow-read --allow-write --allow-run jsr:@maximilian-hammerl/deno-project-config-check
```

### Permissions

| Permission | Reason |
|-----------------|--------------------------------------------------------------------------------|
| `--allow-read` | Read your `deno.jsonc`, `deno.json` or `import_map.json` config file |
| `--allow-write` | Write the temporary config file and, if configured, overwrite your config file |
| `--allow-run` | Run `deno check` to test whether import can be removed |

## Contributing

Contributions are welcome!
If you have ideas for new features or improvements, feel free to open an issue or submit a pull request.

## License

This project is licensed under the [MIT License](LICENSE.md).
11 changes: 9 additions & 2 deletions deno.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@maximilian-hammerl/deno-project-config-check",
"version": "0.1.0",
"version": "0.1.1",
"license": "MIT",
"lock": false,
"tasks": {
Expand All @@ -27,5 +27,12 @@
"semiColons": false,
"singleQuote": true
},
"exports": "./main.ts"
"exports": "./src/main.ts",
"publish": {
"include": [
"LICENSE.md",
"README.md",
"src/**/*.ts"
]
}
}
File renamed without changes.

0 comments on commit 1a0ab0f

Please sign in to comment.