npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

codemirror-addon-toggle-comment

v0.11.1

Published

CodeMirror addon: another way to indent your code

Downloads

18

Readme

CodeMirror Addon Toggle Comment

CodeMirror 5 does come with a comment addon, but I wanted to use the same algorithm used in Brackets

This addon is that: I ported the code related to commenting code from Brackets and experimented a bit, integrating features of the original one.

Used in Quadre editor.

How to install

The addon is released on npm so just run

npm install codeMirror-addon-toggle-comment

How to use

It defines two extensions: cm.toggleLineComment(options?) and cm.toggleBlockComment(options?).

Options

indent?: boolean

If false the comment will start at the start of the line, otherwise will try to match the indentation of the selected code.

padding?: string

A string that will be inserted after opening and before closing comment marker.

commentBlankLines?: boolean

Whether, when adding line comments, to also comment lines that contain only whitespace.

lineComment?: string | string[]

The strings used for commenting the code in case of line comment.

blockCommentStart?: string

The string used for commenting the code at the start of a block comment.

blockCommentEnd?: string

The string used for commenting the code at the end of a block comment.

getMode?: (mode, pos)

It returns an object with these properties: lineComment, blockCommentStart and blockCommentEnd. When this options is used the lineComment, blockCommentStart and blockCommentEnd options will be ignored.

Example:

codeMirror.toggleLineComment({
    indent: true,
    padding: " "
});

Differences in distributed files

  • toggle-comment-simple.js: this relies on CodeMirror but also on lodash 4, so you should install yourself

  • toggle-comment.js: this relies on CodeMirror, lodash code is already incorporated.

  • toggle-comment-simple.mjs: this relies on CodeMirror, lodash code is already incorporated. It is experimental for direct use in a ES6 code base.