Prettier Plugin

prettier-plugin-noshift.js is an official Prettier plugin that formats .nsjs files.

Installation

Install the plugin as a dev dependency alongside Prettier:

npm install --save-dev prettier prettier-plugin-noshift.js

Configuration

Add the plugin to your .prettierrc (or equivalent config file):

{
  "semi": true,
  "singleQuote": false,
  "plugins": ["prettier-plugin-noshift.js"]
}

If you scaffold a project with nsc create, the Prettier plugin is automatically installed and configured.

How It Works

The plugin converts .nsjs code to JavaScript, formats it with Prettier's built-in JavaScript formatter, then converts the result back to NoShift.js syntax. All standard Prettier options (e.g., semi, singleQuote, tabWidth) are forwarded.

Pipeline

1. .nsjs → JavaScript (convert)
2. JavaScript → formatted JavaScript (Prettier)
3. formatted JavaScript → .nsjs (reverse convert)

Example

Before:

const  x  =  1  ;
function greet^8name^9 ^[
  const msg=^2^3hello, ^2^;name;
console.log^8msg^9 ;
  return  msg ;
^]

After formatting:

const x ^- 1;
function greet^8name^9 ^[
  const msg ^- ^2^3hello, ^2 ^; name;
  console.log^8msg^9;
  return msg;
^]

Supported Options

All standard Prettier options are supported. Common ones include:

View on npm →