@terminal-nerds/snippets-project

@terminal-nerds reusable snippets for projects.


Keywords
snippets, typescript, project
License
MIT
Install
npm install @terminal-nerds/snippets-project@0.2.3

Documentation

Snippets

pnpm workspace badge changesets badge turborepo badge vitest badge

โžก๏ธ This project is a monorepo made with pnpm workspace and powered by changesets, turborepo, vitest.

sauron-monorepo-meme

Project goal

๐ŸŽฏ Collect all code snippets in one repository, and keep them organized.

What are snippets?

Reusable pieces of code, which can be reused across the projects.

Why?

  • follows the DRY principle,
  • easier maintainability,
  • testable, and easier to debug,
  • prevents searching for a snippet in projects,
  • lowers the amount of automated dependencies updates in Pull Requests,
  • eases the issues during the attempts to revive a project with legacy code.

Features

  • typed ๐Ÿ“‘,
  • tested ๐Ÿงช,
  • tree-shakeable ๐ŸŽ‹ - (bundless can easily do "code-splitting"),
  • relieves the count of project dependencies โ˜€๏ธ - you have a better view of what package is being used, for what, and where.

Note
They are written with ES Module (ESM) type - we adhere to the future of JavaScript (following EcmaScript).
Hence they can be used in as many runtimes as possible, such as:

  • Node.js icon Node.js,
  • Deno icon Deno,
  • Bun icon Bun,
  • modern website browsers.

Packages

workflow CI-CD badge dependencies badge

๐Ÿ“ฆ The following packages are available under the packages/ directory.

Note
All of them are scoped - they are prefixed with @terminal-nerds/.
They are accessible for public use and downloadable from the npmjs.com registry.
Also, package names are prefixed with snippets-.
So, the final name format is: @terminal-nerds/snippets-<package name>.

Name Version
array badge array version badge
config badge config version badge
error badge error version badge
extension badge extension version badge
function badge function version badge
number badge number version badge
object badge object version badge
package badge package version badge
project badge project version badge
regexp badge regexp version badge
runtime badge runtime version badge
string badge string version badge
test badge test version badge
type badge type version badge
url badge url version badge

Security

workflow maintenance badge Snyk vulnerabilities badge

๐Ÿ” Our team has a shared Security Policy. If you have concerns or found an issue, please follow the instructions, and remember one thing:

Warning
We are all ears, but please, DO NOT create a GitHub issue for reporting a vulnerability.


License

License badge

โš–๏ธ The code, including packages, is licensed under the MIT license.

FOSSA Status Card

Project contributors

contributors badge discord badge

๐Ÿฅฐ Thanks go to these wonderful people and bots (emoji key):


Matt Kadlubowski

๐Ÿ’ป ๐Ÿšง

changesets

๐Ÿ“– ๐Ÿ“ฆ ๐Ÿ”ง

Renovate Bot

๐Ÿšง ๐Ÿ›ก๏ธ ๐Ÿ”ง

Snyk bot

๐Ÿšง ๐Ÿ›ก๏ธ ๐Ÿ”ง

CodeSee

๐Ÿ‘€ ๐Ÿ”ง

Contributing

SonarCloud badge coverage badge CodeClimate issues badge

๐Ÿค This project follows the all-contributors specification.
Therefore, contributions of any kind are welcome!

Please refer to our CONTRIBUTING file for more information about getting involved.

Author

๐ŸŽ‰ The idea of this project repository was initiated by xeho91. However, it's the contributors who matter the most.