Skip to content

Commit

Permalink
Fresh project overview, auto-format
Browse files Browse the repository at this point in the history
  • Loading branch information
@webpro
webpro committed May 6, 2024
1 parent 6767fb3 commit 79cf631
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 85 deletions.
108 changes: 53 additions & 55 deletions packages/docs/src/content/docs/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,40 @@ Using Knip in a commercial project? Please consider [sponsoring me][1]!
</Card>
</CardGrid>

## 🧡 Projects Using Knip

:::section{.columns.min300}

- [ArkType][6]
- [Backstage][7]
- [Cody (SourceGraph)][8]
- [Create TypeScript App][9]
- [DefinitelyTyped-tools (Microsoft)][10]
- [ESLint][11]
- [freeCodeCamp][12]
- [Fuels][13]
- [Grafana][14]
- [InvokeAI][15]
- [Monkeytype][16]
- [Nuxt][17]
- [Release It!][18]
- [Svelte][19]
- [TanStack Query][20]
- [TanStack Table][21]
- [TypeStat][22]

:::

## 🧡 Introduction Video

[James Shopland][6] created this great introduction and overview of Knip:
[James Shopland][23] created this great introduction and overview of Knip:

<YouTube id="uhEkgWt-pUM" />

## 🧡 Sponsors

Big shoutout to the awesome companies and people sponsoring this project! See
[Sponsors][7] for the full list.
[Sponsors][24] for the full list.

<Sponsors direction="row" showAll={false} />

Expand All @@ -81,69 +105,43 @@ Special thanks to the wonderful people who have contributed to this project!
## 🧡 Articles

- Smashing Magazine: [Knip: An Automated Tool For Finding Unused Files, Exports,
And Dependencies][8]
And Dependencies][25]
- Effective TypeScript: [Recommendation Update: ✂️ Use knip to detect dead code
and types][9]
- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][10]
- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][11]
and types][26]
- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][27]
- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][28]

## 🧡 Testimonials

<Tweets />

## 🧡 Selected Projects Using Knip

:::section{.columns.min300}

- [Argos][12]
- [ESLint][13]
- [freeCodeCamp][14]
- [gajus/slonik][15]
- [JoshuaKGoldberg/create-typescript-app][16]
- [microsoft/DefinitelyTyped-tools][17]
- [Monkeytype][18]
- [Release It!][19]
- [sourcegraph/cody][20]
- [Svelte][21]
- [TanStack/query][22]
- [TanStack/table][23]
- [Tipi][24]
- [Wagmi][25]

:::

Use [GitHub Search for `package.json` files containing "knip"][26] for more
projects and examples using Knip.

Have or know about a nice resource about or project using Knip? Feel free to
propose a change and add it to this page!

[1]: https://github.com/sponsors/webpro
[2]: ./overview/getting-started.mdx
[3]: ./explanations/why-use-knip.md
[4]: ./guides/troubleshooting.md
[5]: ./reference/plugins.md
[6]: https://www.jamesshopland.com
[7]: ./sponsors
[8]:
[6]: https://github.com/arktypeio/arktype
[7]: https://github.com/backstage/backstage
[8]: https://github.com/sourcegraph/cody
[9]: https://github.com/JoshuaKGoldberg/create-typescript-app
[10]: https://github.com/microsoft/DefinitelyTyped-tools
[11]: https://github.com/eslint/eslint
[12]: https://github.com/freeCodeCamp/freeCodeCamp
[13]: https://github.com/FuelLabs/fuels-ts
[14]: https://github.com/grafana/grafana
[15]: https://github.com/invoke-ai/InvokeAI
[16]: https://github.com/monkeytypegame/monkeytype
[17]: https://github.com/nuxt/nuxt
[18]: https://github.com/release-it/release-it
[19]: https://github.com/sveltejs/svelte
[20]: https://github.com/TanStack/query
[21]: https://github.com/TanStack/table
[22]: https://github.com/JoshuaKGoldberg/TypeStat
[23]: https://www.jamesshopland.com
[24]: ./sponsors
[25]:
https://www.smashingmagazine.com/2023/08/knip-automated-tool-find-unused-files-exports-dependencies/
[9]: https://effectivetypescript.com/2023/07/29/knip/
[10]: https://madelinemiller.dev/blog/knip-dead-code/
[11]:
[26]: https://effectivetypescript.com/2023/07/29/knip/
[27]: https://madelinemiller.dev/blog/knip-dead-code/
[28]:
https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
[12]: https://github.com/argos-ci/argos
[13]: https://github.com/eslint/eslint
[14]: https://github.com/freeCodeCamp/freeCodeCamp
[15]: https://github.com/gajus/slonik
[16]: https://github.com/JoshuaKGoldberg/create-typescript-app
[17]: https://github.com/microsoft/DefinitelyTyped-tools
[18]: https://github.com/monkeytypegame/monkeytype
[19]: https://github.com/release-it/release-it
[20]: https://github.com/sourcegraph/cody
[21]: https://github.com/sveltejs/svelte
[22]: https://github.com/TanStack/query
[23]: https://github.com/TanStack/table
[24]: https://github.com/runtipi/runtipi
[25]: https://github.com/wevm/wagmi
[26]:
https://github.com/search?q=path%3A%2F%28%5E%7C%5C%2F%29package%5C.json%24%2F+knip&type=code
60 changes: 30 additions & 30 deletions packages/docs/src/content/docs/overview/features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,38 @@ Overview of features supported by Knip (A-Z):

| Name | Description or example |
| :---------------------------------------- | :--------------------------------------------------------- |
| [Auto-fix][5] | Use `--fix` to auto-fix issues |
| [Cache][14] | Use `--cache` to speed up consecutive runs |
| [CommonJS][11] | JavaScript is just fine |
| [Compilers][6] (built-in/custom) | Support for Astro, MDX, Vue, etc. |
| [Debug][12] | Use `--debug` for troubleshooting |
| [Filters][4] | Exclude or focus on specific issue types |
| [JSDoc tags][16] | Make exceptions for exports |
| [Monorepos][2] (package-based/integrated) | Workspaces are first-class citizen |
| [Performance][13] | Use `--performance` for detailed timing insights |
| [Auto-fix][1] | Use `--fix` to auto-fix issues |
| [Cache][2] | Use `--cache` to speed up consecutive runs |
| [CommonJS][3] | JavaScript is just fine |
| [Compilers][4] (built-in/custom) | Support for Astro, MDX, Vue, etc. |
| [Debug][5] | Use `--debug` for troubleshooting |
| [Filters][6] | Exclude or focus on specific issue types |
| [JSDoc tags][7] | Make exceptions for exports |
| [Monorepos][8] (package-based/integrated) | Workspaces are first-class citizen |
| [Performance][9] | Use `--performance` for detailed timing insights |
| [Plugins][10] | Over 60 plugins with custom entry paths and config parsing |
| [Preprocessors][8] | Preprocess issues before being reported |
| [Production mode][1] | Use `--production` to lint only production code |
| [Reporters][7] (built-in/custom) | Use a custom `--reporter ./custom-output.ts` |
| [Rules][3] | Exclude or focus on issue types |
| [Script parser][9] | Scripts contain dependencies and entry paths |
| [Watch mode][15] | Use `--watch` to update the reporter on file changes |
| [Preprocessors][11] | Preprocess issues before being reported |
| [Production mode][12] | Use `--production` to lint only production code |
| [Reporters][13] (built-in/custom) | Use a custom `--reporter ./custom-output.ts` |
| [Rules][14] | Exclude or focus on issue types |
| [Script parser][15] | Scripts contain dependencies and entry paths |
| [Watch mode][16] | Use `--watch` to update the reporter on file changes |
| [Workspace][17] | Lint only a single workspace in a monorepo |

[1]: ../features/production-mode.md
[2]: ../features/monorepos-and-workspaces.md
[3]: ../features/rules-and-filters.md#rules
[4]: ../features/rules-and-filters.md#filters
[5]: ../features/auto-fix.mdx
[6]: ../features/compilers.md
[7]: ../features/reporters.md
[8]: ../features/reporters.md#preprocessors
[9]: ../features/script-parser.md
[1]: ../features/auto-fix.mdx
[2]: ../reference/cli.md#--cache
[3]: ../guides/working-with-commonjs.md
[4]: ../features/compilers.md
[5]: ../guides/troubleshooting.md#issues-reported-by-knip
[6]: ../features/rules-and-filters.md#filters
[7]: ../reference/jsdoc-tsdoc-tags.md
[8]: ../features/monorepos-and-workspaces.md
[9]: ../reference/cli.md#--performance
[10]: ../explanations/plugins.md
[11]: ../guides/working-with-commonjs.md
[12]: ../guides/troubleshooting.md#issues-reported-by-knip
[13]: ../reference/cli.md#--performance
[14]: ../reference/cli.md#--cache
[15]: ../reference/cli.md#--watch
[16]: ../reference/jsdoc-tsdoc-tags.md
[11]: ../features/reporters.md#preprocessors
[12]: ../features/production-mode.md
[13]: ../features/reporters.md
[14]: ../features/rules-and-filters.md#rules
[15]: ../features/script-parser.md
[16]: ../reference/cli.md#--watch
[17]: ../features/monorepos-and-workspaces#lint-a-single-workspace

0 comments on commit 79cf631

Please sign in to comment.