chore: rename package

roxlabs · Sep 8, 2023 · 9855db3 · 9855db3
1 parent 3e3785d
commit 9855db3
Show file tree

Hide file tree

Showing 21 changed files with 73 additions and 70 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,18 @@
 # Snippets from actual code
 
-Snippetfy extracts code snippets from codebases to ensure code embeded on documentation, blog posts and books are always *correct* and *up-to-date*. Stop writing code on Markdown and HTML files and focus on working samples.
+Coldsnip extracts code snippets from codebases to ensure code embeded on documentation, blog posts and books are always *correct* and *up-to-date*. Stop writing code on Markdown and HTML files and focus on working samples.
 
 
-![NPM](https://img.shields.io/npm/v/@snippetfy/core?style=flat-square)
+![NPM](https://img.shields.io/npm/v/@coldsnip/core?style=flat-square)
 
 
 ## About the project
 
-This project was motivated by past experiences dealing with outdated or faulty code samples in documentation, as both an open source maintainer and consumer. As developers, we often make mistakes when writing code directly on Markdown or HTML files. Snippetfy attempts to avoid those mistakes by pulling code snippets tagged in actual source code.
+This project was motivated by past experiences dealing with outdated or faulty code samples in documentation, as both an open source maintainer and consumer. As developers, we often make mistakes when writing code directly on Markdown or HTML files. Coldsnip attempts to avoid those mistakes by pulling code snippets tagged in actual source code.
 
 ## Getting Started
 
-Snippetfy can be used as a library, as a CLI or through direct integrations with other platforms. Check the [getting started guide](https://roxlabs.github.io/snippetfy/getting-started/) in order to determine the best option for your needs.
+Coldsnip can be used as a library, as a CLI or through direct integrations with other platforms. Check the [getting started guide](https://roxlabs.github.io/coldsnip/getting-started/) in order to determine the best option for your needs.
 
 ### CLI Commands
 
@@ -67,13 +67,13 @@ export type Snippets = { [key: string]: Snippet[] };
 
 ## Roadmap
 
-See the [open feature requests](https://github.com/roxlabs/snippetfy/labels/enhancement) for a list of proposed features and join the discussion.
+See the [open feature requests](https://github.com/roxlabs/coldsnip/labels/enhancement) for a list of proposed features and join the discussion.
 
 ## Contributing
 
 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
 
-1. Make sure you read our [Code of Conduct](https://github.com/roxlabs/snippetfy/blob/main/CODE_OF_CONDUCT.md)
+1. Make sure you read our [Code of Conduct](https://github.com/roxlabs/coldsnip/blob/main/CODE_OF_CONDUCT.md)
 1. Fork the project and clone your fork
 1. Setup the local environment with `npm install`
 1. Create a feature branch (`git checkout -b feature/AmazingFeature`) or a bugfix branch (`git checkout -b fix/BoringBug`)
@@ -84,4 +84,4 @@ Contributions are what make the open source community such an amazing place to b
 
 ## License
 
-Distributed under the MIT License. See [LICENSE](https://github.com/roxlabs/snippetfy/blob/main/LICENSE) for more information.
+Distributed under the MIT License. See [LICENSE](https://github.com/roxlabs/coldsnip/blob/main/LICENSE) for more information.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -8,7 +8,7 @@
 # For technical reasons, this file is *NOT* reloaded automatically when you use
 # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
 #
-# If you need help with YAML syntax, here are some quick references for you: 
+# If you need help with YAML syntax, here are some quick references for you:
 # https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
 # https://learnxinyminutes.com/docs/yaml/
 #
@@ -18,12 +18,12 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: Snippetfy
+title: Coldsnip
 description: >- # this means to ignore newlines until "baseurl:"
   Write an awesome description for your new site here. You can edit this
   line in _config.yml. It will appear in your document head meta (for
   Google search results) and in your feed.xml site description.
-baseurl: "/snippetfy" # the subpath of your site, e.g. /blog
+baseurl: "/coldsnip" # the subpath of your site, e.g. /blog
 url: "https://roxlabs.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 permalink: pretty
 twitter_username: drochetti

diff --git a/docs/_includes/cli/README.md b/docs/_includes/cli/README.md
@@ -1,14 +1,14 @@
 # Usage
 <!-- usage -->
 ```sh-session
-$ npm install -g snippetfy
-$ snippetfy COMMAND
+$ npm install -g coldsnip
+$ coldsnip COMMAND
 running command...
-$ snippetfy (-v|--version|version)
-snippetfy/0.8.1 darwin-x64 node-v14.17.3
-$ snippetfy --help [COMMAND]
+$ coldsnip (-v|--version|version)
+coldsnip/0.8.1 darwin-x64 node-v14.17.3
+$ coldsnip --help [COMMAND]
 USAGE
-  $ snippetfy COMMAND
+  $ coldsnip COMMAND
 ...
 ```
 <!-- usagestop -->
diff --git a/docs/_includes/footer_custom.html b/docs/_includes/footer_custom.html
@@ -1,5 +1,5 @@
 <p class="text-small text-grey-dk-100 mb-0">
   &copy; {{ site.time | date: '%Y' }} <a href="https://roxlabs.dev" target="_blank">Roxlabs</a>.
-  Distributed by an <a href="https://github.com/roxlabs/snippetfy/blob/main/LICENSE" target="_blank">MIT license</a>.
-  View the <a href="https://github.com/roxlabs/snippetfy" target="_blank">source on GitHub</a>.
+  Distributed by an <a href="https://github.com/roxlabs/coldsnip/blob/main/LICENSE" target="_blank">MIT license</a>.
+  View the <a href="https://github.com/roxlabs/coldsnip" target="_blank">source on GitHub</a>.
 </p>
diff --git a/docs/_includes/home.md b/docs/_includes/home.md
diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
@@ -7,19 +7,19 @@ has_children: true
 
 # Getting started
 
-For most use cases, using the Snippetfy CLI is the easiest way to go. You can also use it programmatically if your goal is to integrate with other systems or create a plugin for your favorite Markdown parser or static site generator.
+For most use cases, using the Coldsnip CLI is the easiest way to go. You can also use it programmatically if your goal is to integrate with other systems or create a plugin for your favorite Markdown parser or static site generator.
 
 Let's explore those two options.
 
 ## CLI
 
 ```
-snippetfy --format markdown --out snippets/ 
+coldsnip --format markdown --out snippets/
 ```
 
 ### Config file
 
-In order to `.snippetfy.js` 
+In order to `.coldsnip.js`
 
 ```js
 module.exports = {

diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,7 @@
 layout: default
 title: Home
 nav_order: 1
-description: "Snippetfy, a library to extract code snippets from source files. Never deal with broken code samples in your documentation and books anymore, make sure they are actual working code."
+description: "Coldsnip, a library to extract code snippets from source files. Never deal with broken code samples in your documentation and books anymore, make sure they are actual working code."
 permalink: /
 ---
 

diff --git a/docs/reference/index.md b/docs/reference/index.md
diff --git a/docs/reference/interfaces/GitRepo.md b/docs/reference/interfaces/GitRepo.md
@@ -32,7 +32,7 @@ An optional branch name.
 
 #### Defined in
 
-[types.ts:64](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L64)
+[types.ts:64](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L64)
 
 ___
 
@@ -44,7 +44,7 @@ The file pattern / glob to match.
 
 #### Defined in
 
-[types.ts:54](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L54)
+[types.ts:54](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L54)
 
 ___
 
@@ -62,7 +62,7 @@ false
 
 #### Defined in
 
-[types.ts:59](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L59)
+[types.ts:59](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L59)
 
 ___
 
@@ -74,7 +74,7 @@ The remote Git repository URL.
 
 #### Defined in
 
-[types.ts:52](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L52)
+[types.ts:52](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L52)
 
 ___
 
@@ -92,4 +92,4 @@ The directory where the repo should be cloned to.
 
 #### Defined in
 
-[types.ts:69](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L69)
+[types.ts:69](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L69)
diff --git a/docs/reference/interfaces/LocalPath.md b/docs/reference/interfaces/LocalPath.md
@@ -23,7 +23,7 @@ The relative or absolute path.
 
 #### Defined in
 
-[types.ts:41](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L41)
+[types.ts:41](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L41)
 
 ___
 
@@ -35,4 +35,4 @@ The file pattern / glob to match.
 
 #### Defined in
 
-[types.ts:43](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L43)
+[types.ts:43](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L43)
diff --git a/docs/reference/interfaces/Snippet.md b/docs/reference/interfaces/Snippet.md
@@ -25,7 +25,7 @@ The snippet content. Leading spaces are trimmed.
 
 #### Defined in
 
-[types.ts:16](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L16)
+[types.ts:16](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L16)
 
 ___
 
@@ -37,7 +37,7 @@ The end line of the snippet.
 
 #### Defined in
 
-[types.ts:14](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L14)
+[types.ts:14](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L14)
 
 ___
 
@@ -49,7 +49,7 @@ The source language. It matches the file extension.
 
 #### Defined in
 
-[types.ts:8](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L8)
+[types.ts:8](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L8)
 
 ___
 
@@ -61,7 +61,7 @@ The link to the file on the remote Git repo when available.
 
 #### Defined in
 
-[types.ts:18](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L18)
+[types.ts:18](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L18)
 
 ___
 
@@ -74,7 +74,7 @@ that might come from the same file extension.
 
 #### Defined in
 
-[types.ts:23](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L23)
+[types.ts:23](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L23)
 
 ___
 
@@ -86,7 +86,7 @@ The file path relative to the working directory.
 
 #### Defined in
 
-[types.ts:10](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L10)
+[types.ts:10](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L10)
 
 ___
 
@@ -98,4 +98,4 @@ The start line of the snippet.
 
 #### Defined in
 
-[types.ts:12](https://github.com/roxlabs/snippetfy/blob/969d5ca/src/types.ts#L12)
+[types.ts:12](https://github.com/roxlabs/coldsnip/blob/3e3785d/src/types.ts#L12)
diff --git a/package-lock.json b/package-lock.json