@kitschpatrol/snip 0.0.1

package/license.txt

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2023 - 2024 Eric Mika
+
+Based on the MIT-licensed "Snipster" project by Jared Hanstra
+
+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.

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@kitschpatrol/snip",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "A CLI tool for snippet management.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kitschpatrol/snip.git"
+  },
+  "homepage": "https://github.com/kitschpatrol/snip",
+  "bugs": {
+    "url": "https://github.com/kitschpatrol/snip/issues",
+    "email": "eric@ericmika.com"
+  },
+  "author": {
+    "name": "Eric Mika",
+    "email": "eric@ericmika.com",
+    "url": "https://ericmika.com"
+  },
+  "contributors": [
+    {
+      "name": "Original Author: Jared Hanstra",
+      "url": "https://github.com/jhanstra"
+    }
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=8.0.0"
+  },
+  "bin": {
+    "snip": "./bin/cli.js"
+  },
+  "main": "./bin/cli.js",
+  "files": [
+    "bin/*"
+  ],
+  "keywords": [
+    "cli",
+    "snippets",
+    "vscode"
+  ],
+  "dependencies": {
+    "@commander-js/extra-typings": "^12.1.0",
+    "commander": "^12.1.0",
+    "execa": "^9.1.0",
+    "fs-extra": "^11.2.0",
+    "ignore-walk": "^6.0.5",
+    "inquirer": "^9.2.22"
+  },
+  "devDependencies": {
+    "@fig/complete-commander": "^3.0.0",
+    "@kitschpatrol/shared-config": "^4.6.6",
+    "@types/fs-extra": "^11.0.4",
+    "@types/ignore-walk": "^4.0.3",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^20.12.12",
+    "bumpp": "^9.4.1",
+    "chalk": "^5.3.0",
+    "date-fns": "^3.6.0",
+    "esbuild": "^0.21.4",
+    "node-jq": "^4.4.0",
+    "npm-run-all": "^4.1.5",
+    "tslog": "^4.9.2",
+    "tsx": "^4.11.0",
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0",
+    "zod": "^3.23.8"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsx ./scripts/build-cli.ts",
+    "fig:generate": "npm run build && NODE_ENV=development node bin/cli.js generate-fig-spec > /tmp/snip.ts && npx @fig/publish-spec -p /tmp/snip.ts && rm /tmp/snip.ts",
+    "fix": "pnpm shared-config --fix",
+    "lint": "pnpm shared-config --lint",
+    "prebuild": "jq '{command: .bin | keys[], version, description}' package.json > ./src/generated/package-info.json",
+    "release": "pnpm run build && pnpm bumpp --commit 'Release: %s' && pnpm publish --otp $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')",
+    "start": "node ./bin/cli.js",
+    "test": "vitest",
+    "update-language-data": "tsx ./scripts/update-vscode-language-data.ts"
+  }
+}

package/readme.md

@@ -0,0 +1,134 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+# @kitschpatrol/snip
+
+<!-- /title -->
+
+<!-- badges -->
+
+[![NPM Package @kitschpatrol/snip](https://img.shields.io/npm/v/@kitschpatrol/snip.svg)](https://npmjs.com/package/@kitschpatrol/snip)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+<!-- /badges -->
+
+<!-- short-description -->
+
+**A CLI tool for snippet management.**
+
+<!-- /short-description -->
+
+> \[!CAUTION]
+> This tool is a work in progress, certain commands are not yet implemented and
+> others might behave unpredictably. I don't recommend using it until a 1.0.0
+> release.
+
+## Overview
+
+Snip helps you create, edit, manage, and synchronize code snippets from the command line. Synchronize to (and possibly eventually from) editors like VSCode.
+
+Snip is a fork of [Jared Hanstra](https://github.com/jhanstra)'s [snipster](https://github.com/jhanstra/snipster). Snip includes both some [additions](#background) and some [regressions](#the-future) vs. the original.
+
+## Getting started
+
+### Dependencies
+
+The `snip` CLI tool requires Node 18+.
+
+### Installation
+
+Install globally for access across your system:
+
+```sh
+npm install --global @kitschpatrol/snip
+```
+
+## Usage
+
+TK
+
+### CLI
+
+<!-- cli-help -->
+
+```txt
+Usage: snip [options] [command]
+
+A CLI tool for snippet management.
+
+Options:
+  -v, --version                   output the version number
+  -c, --config <path>             path to configuration file (default:
+                                  "/Users/mika/.config/snip/config.json", env:
+                                  SNIP_CONFIG_FILE)
+  -l, --library <path>            path to library directory where snippets are
+                                  stored (default: "/Users/mika/.snip", env:
+                                  SNIP_LIBRARY_DIR)
+  -d, --debug                     extra logging for troubleshooting (default:
+                                  false, env: SNIP_DEBUG)
+  -h, --help                      display help for command
+
+Commands:
+  add [filename]                  add a snippet
+  cd                              launch a shell in the snippets directory
+  list                            list all snippets
+  setup                           set up snip
+  sync-to-editors [editors...]    sync snippets to editors
+  sync-from-editors [editors...]  sync snippets from editors (not yet
+                                  implemented)
+  help [command]                  display help for command
+```
+
+<!-- /cli-help -->
+
+#### Examples
+
+TK
+
+## Background
+
+Snip is a fork of [Jared Hanstra](https://github.com/jhanstra)'s [snipster](https://github.com/jhanstra/snipster).
+
+Modifications include:
+
+- A monosyllabic name 😅.
+- Migration from JavaScript → TypeScript + Zod.
+- Migration from CommonJS → ES Modules.
+- Migration from Yarn → PNPM.
+- Added `.ignore` file support.
+- Added `$EDITOR` support for creating new snippets.
+- Added support for `~` in paths.
+- Implemented a new automated language ID aggregation approach based on scraping plugin manifests from the VSCode marketplace.
+- Added support for snippet descriptions — stored in the snippet file name itself.
+
+## The future
+
+- [ ] Figure out what to do about [Fig integration](https://github.com/withfig/autocomplete-tools/blob/main/integrations/commander/README.md>).
+- [ ] Additional editor adapters
+- [ ] Sync-from-editor migration fixes
+- [ ] Cosmiconfig
+
+## Maintainers
+
+[@kitschpatrol](https://github.com/kitschpatrol)
+
+## Acknowledgements
+
+[Jared Hanstra](https://github.com/jhanstra) is the author of the original [snipster](https://github.com/jhanstra/snipster) project on which Snip is based.
+
+<!-- contributing -->
+
+## Contributing
+
+[Issues](https://github.com/kitschpatrol/snip/issues) and pull requests are welcome.
+
+<!-- /contributing -->
+
+<!-- license -->
+
+## License
+
+[MIT](license.txt) © Eric Mika
+
+<!-- /license -->