@igor.dvlpr/comment-it v2.2.1
/* CommentIt! */
๐ Formats the provided string as a comment, either a single or a multi line comment for the given programming language. ๐ป
โจSince version 2.0.0
CommentIt!
is a hybrid module that supports both CommonJS (legacy) and ES modules, thanks to Modern Module.
Usage
Install it by running,
npm i "@igor.dvlpr/comment-it"
API
getLanguageIds()
getLanguageIds(): string[]
Gets IDs of all available language formatters. Language formatters are callable as comment.<languageId>
. See more below at comment
.
language()
language(id: string): CommentFormatter | null
Performs a case-insensitive search for a language formatter with the provided id
and returns it - if one is found - else returns null.
supportsLanguage()
supportsLanguage(id: string): boolean
Returns whether the given language formatter is supported, case-insensitive.
Supported identifiers are: ada
,bash
,batch
,c
,carbon
,cSharp
,coffeeScript
,cpp
,crystal
,css
,dart
,delphi
,dockerFile
,elixir
,erlang
,euphoria
,fSharp
,fortran
,genie
,go
,groovy
,hack
,haskell
,html
,icon
,java
,javaScript
,jsx
,julia
,kotlin
,lisp
,liveCode
,lua
,maple
,matlab
,mercury
,mql4
,objectiveC
,objectiveCpp
,oz
,pascal
,perl
,php
,powerShell
,pug
,python
,q
,r
,razor
,red
,ring
,ruby
,rust
,scala
,shellScript
,sql
,swift
,typeScript
,vala
,visualBasic
,vue
,vueHtml
,xml
.
alias()
alias(id: LanguageId, alias: string): boolean
Adds an alias for an existing comment formatter. Returns true upon success, false otherwise.
comment
An object
where all formatters are stored.
comment
's formatters:
comment.ada
- Adacomment.bash
- Bash (alias ofshellScript
)comment.batch
- Batchcomment.c
- Ccomment.carbon
- Carboncomment.cSharp
- C#comment.coffeeScript
- CoffeeScriptcomment.cpp
- C++comment.crystal
- Crystalcomment.css
- CSScomment.dart
- Dartcomment.delphi
- Delphicomment.dockerFile
- Dockerfilecomment.elixir
- Elixircomment.erlang
- Erlangcomment.euphoria
- Euphoriacomment.fortran
- Fortrancomment.fSharp
- F#comment.genie
- Geniecomment.go
- Gocomment.groovy
- Groovycomment.hack
- Hackcomment.haskell
- Haskellcomment.html
- HTMLcomment.icon
- Iconcomment.java
- Javacomment.javaScript
- JavaScriptcomment.jsx
- JSXcomment.julia
- Juliacomment.kotlin
- Kotlincomment.lisp
- Lispcomment.liveCode
- LiveCodecomment.lua
- Luacomment.maple
- Maplecomment.matlab
- MATLABcomment.mercury
- Mercurycomment.mql4
- MQL4comment.objectiveC
- Objective-Ccomment.objectiveCpp
- Objective-C++comment.oz
- Ozcomment.pascal
- Pascalcomment.perl
- Perlcomment.php
- PHPcomment.powerShell
- PowerShellcomment.pug
- Pug/Jadecomment.python
- Pythoncomment.q
- Qcomment.r
- Rcomment.razor
- Razorcomment.red
- Redcomment.ring
- Ringcomment.ruby
- Rubycomment.rust
- Rustcomment.scala
- Scalacomment.shellScript
- ShellScript/Bashcomment.sql
- SQLcomment.swift
- Swiftcomment.typeScript
- TypeScriptcomment.vala
- Valacomment.visualBasic
- VisualBasiccomment.vue
- Vuecomment.vueHtml
- VueHtmlcomment.xml
- XML
Each formatter exposes two functions, single()
for single-line comments and multi()
for multi-line comments.
single()
single(value: string): string
Returns a single-line comment formatted for the selected language.
multi()
multi(value: string): string
Returns a multi-line comment formatted for the selected language.
Examples
const { comment, supportsLanguage } = require('@igor.dvlpr/comment-it')
const singleLine = 'hello world'
const multiLine = `hello
world
this is a test`
console.log(comment.javaScript.single(singleLine)) // prints '// hello world'
console.log(comment.jsx.single(singleLine)) // prints '{/* hello world */}'
console.log(comment.coffeeScript.multi(multiLine)) // prints '###\nhello\n\n\nworld\n\nthis is a test\n###'
// note: new lines in the example results are written as-is for brevity
console.log(supportsLanguage('lua')) // prints true
console.log(supportsLanguage('TYPEscript')) // prints true
console.log(supportsLanguage('foo')) // prints false