Skip to content

Commit

Permalink
Add article + format
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Oct 31, 2024
1 parent d536d5a commit fe4f6a8
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 28 deletions.
39 changes: 21 additions & 18 deletions packages/docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,44 +117,47 @@ Special thanks to the wonderful people who have contributed to this project:

Most recent article first:

- [มาทำความสะอาด Project โค้ดของเราด้วย Knip กัน][6] (2024-10-22/Thai)
- Anthony Pena: [Knip: l'ultime outil pour faire le ménage dans vos projets!][7]
- Tom MacWright: [Knip: good software for cleaning up TypeScript tech debt][6]
(2024-10-25)
- [มาทำความสะอาด Project โค้ดของเราด้วย Knip กัน][7] (2024-10-22/Thai)
- Anthony Pena: [Knip: l'ultime outil pour faire le ménage dans vos projets!][8]
(2024-10-08/French)
- Taro: [TypeScript/JavaScriptの不要なコードを削除するツール「Knip」の紹介][8]
- Taro: [TypeScript/JavaScriptの不要なコードを削除するツール「Knip」の紹介][9]
(2024-07-25/Japanese)
- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][9]
- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][10]
(2023-09-17)
- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][10]
- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][11]
(2023-08-21)
- Smashing Magazine: [Knip: An Automated Tool For Finding Unused Files, Exports,
And Dependencies][11] (2023-08-14)
And Dependencies][12] (2023-08-14)
- Effective TypeScript: [Recommendation Update: ✂️ Use knip to detect dead code
and types][12] (2023-07-29)
and types][13] (2023-07-29)

## 🧡 Testimonials

<Tweets />

## Read More

- [Unused dependencies][13]
- [Unused exports][14]
- [Unused dependencies][14]
- [Unused exports][15]

[1]: ./explanations/why-use-knip.md
[2]: ./sponsors
[3]: ./playground
[4]: ./guides/troubleshooting.md
[5]: https://www.jamesshopland.com
[6]:
https://engineering.thinknet.co.th/%E0%B8%A1%E0%B8%B2%E0%B8%97%E0%B8%B3%E0%B8%84%E0%B8%A7%E0%B8%B2%E0%B8%A1%E0%B8%AA%E0%B8%B0%E0%B8%AD%E0%B8%B2%E0%B8%94-project-%E0%B9%82%E0%B8%84%E0%B9%89%E0%B8%94%E0%B8%82%E0%B8%AD%E0%B8%87%E0%B9%80%E0%B8%A3%E0%B8%B2%E0%B8%94%E0%B9%89%E0%B8%A7%E0%B8%A2-knip-%E0%B8%81%E0%B8%B1%E0%B8%99-20dbd65f6b58
[6]: https://macwright.com/2024/10/25/good-software-knip
[7]:
https://engineering.thinknet.co.th/%E0%B8%A1%E0%B8%B2%E0%B8%97%E0%B8%B3%E0%B8%84%E0%B8%A7%E0%B8%B2%E0%B8%A1%E0%B8%AA%E0%B8%B0%E0%B8%AD%E0%B8%B2%E0%B8%94-project-%E0%B9%82%E0%B8%84%E0%B9%89%E0%B8%94%E0%B8%82%E0%B8%AD%E0%B8%87%E0%B9%80%E0%B8%A3%E0%B8%B2%E0%B8%94%E0%B9%89%E0%B8%A7%E0%B8%A2-knip-%E0%B8%81%E0%B8%B1%E0%B8%99-20dbd65f6b58
[8]:
https://k49.fr.nf/knip-l-ultime-outil-pour-faire-le-menage-dans-vos-projets/
[8]: https://tech.basemachina.jp/entry/introduction-knip
[9]: https://madelinemiller.dev/blog/knip-dead-code/
[10]:
https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
[9]: https://tech.basemachina.jp/entry/introduction-knip
[10]: https://madelinemiller.dev/blog/knip-dead-code/
[11]:
https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
[12]:
https://www.smashingmagazine.com/2023/08/knip-automated-tool-find-unused-files-exports-dependencies/
[12]: https://effectivetypescript.com/2023/07/29/knip/
[13]: ./typescript/unused-dependencies.md
[14]: ./typescript/unused-exports.md
[13]: https://effectivetypescript.com/2023/07/29/knip/
[14]: ./typescript/unused-dependencies.md
[15]: ./typescript/unused-exports.md
20 changes: 10 additions & 10 deletions packages/docs/src/content/docs/reference/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ In Nx projects you might encounter this error:
NX Daemon process terminated and closed the connection
```

The solution is to
[turn off the Nx Daemon](https://nx.dev/concepts/nx-daemon#turning-it-off):
The solution is to [turn off the Nx Daemon][7]:

```sh
NX_DAEMON=false knip
Expand All @@ -62,7 +61,7 @@ NX_DAEMON=false knip

Knip may report false positives when exports are consumed by external libraries.

Please see [external libs][7].
Please see [external libs][8].

## Definitely Typed packages in `dependencies`

Expand All @@ -87,9 +86,9 @@ similar to how standard ES Modules work.

## `unplugin-icons` imports

[unplugin-icons][8] uses aliased imports to import icons from icon sets as
[unplugin-icons][9] uses aliased imports to import icons from icon sets as
components. Knip cannot resolve these imports and will report them as unused.
Use the [`paths` configuration option][9] to tell Knip where to find the icon
Use the [`paths` configuration option][10] to tell Knip where to find the icon
types. For example:

```json title="knip.json"
Expand All @@ -101,15 +100,16 @@ types. For example:
```

Where `[framework]` is the name of the framework you're using (see [available
types][10]).
types][11]).

[1]: #exceptions-from-config-files
[2]: #false-positives-with-external-libs
[3]: #definitely-typed-packages-in-dependencies
[4]: #extensionless-imports
[5]: ./cli.md#knip-bun
[6]: ./configuration.md#plugins
[7]: ../guides/handling-issues.mdx#external-libraries
[8]: https://github.com/antfu/unplugin-icons
[9]: ./configuration.md#paths
[10]: https://github.com/unplugin/unplugin-icons/tree/main/types
[7]: https://nx.dev/concepts/nx-daemon#turning-it-off
[8]: ../guides/handling-issues.mdx#external-libraries
[9]: https://github.com/antfu/unplugin-icons
[10]: ./configuration.md#paths
[11]: https://github.com/unplugin/unplugin-icons/tree/main/types

0 comments on commit fe4f6a8

Please sign in to comment.