coldsnip v0.9.2

Snippets from actual code

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.

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. Coldsnip attempts to avoid those mistakes by pulling code snippets tagged in actual source code.

Getting Started

Coldsnip can be used as a library, as a CLI or through direct integrations with other platforms. Check the getting started guide in order to determine the best option for your needs.

Library

const snippets = await extractSnippets([
  { path: "src/__tests__", pattern: "snippets/twoSnippets.js" },
]);

The return type is an map between the key and the snippet information, as detailed bellow:

/**
 * Represents a code snippet extracted from a source file. The field
 * `permalink` is only present when the source is from a Git repository.
 */
export interface Snippet {
  /** The source language. It matches the file extension. */
  language: string;
  /** The file path relative to the working directory. */
  sourcePath: string;
  /** The name of the file, derived from `sourcePath`. */
  filename: string;
  /** The start line of the snippet. */
  startLine: number;
  /** The end line of the snippet. */
  endLine: number;
  /** The lines to be highlighted, if any. */
  highlightedLines: number[];
  /** The snippet content. Leading spaces are trimmed. */
  content: string;
  /** The link to the file on the remote Git repo when available. */
  permalink?: string;
  /**
   * An extra qualifier that can be used to differentiate snippets with the same key
   * that might come from the same file extension.
   */
  qualifier?: string;
}

/**
 * A map between a `key` and a collection of {@link Snippet} represented by it.
 * Different snippets can be identified by the same key, which is the case in projects
 * with support to multiple languages that want to provide samples of the same API in
 * each supported language.
 */
export type Snippets = { [key: string]: Snippet[] };

Roadmap

See the open feature requests 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
2. Fork the project and clone your fork
3. Setup the local environment with npm install
4. Create a feature branch (git checkout -b feature/cool-thing) or a bugfix branch (git checkout -b fix/bad-bug)
5. Commit the changes (git commit -m 'feat: some meaningful message')
6. Push to the branch (git push origin feature/cool-thing)
7. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.