Git Product home page Git Product logo

format-jsonc's Introduction

@mattinsler/format-jsonc

Consistent formatting for JSONC files

Example

import { format, parseFileSync } from '@mattinsler/format-jsonc';

// read a json file and parse it
const ast = parseFileSync('./tsconfig.json');
// format back to JSONC
format(ast);

// sort all objects and then format to JSONC
format(ast, [sortObjects()]);

// only sort the array named "sort-me"
format(ast, [sortArrays((path) => isObjectPropertyNamed('sort-me'))]);

API

Parsing

  • parse(text: string): ASTObject
  • parseFile(filename: string): Promise
  • parseFileSync(filename: string): ASTObject

Formatting

  • format(ast: ASTArray | ASTObject): string
  • format(ast: ASTArray | ASTObject, transforms: Transform[]): string

Transforming

  • sortArrays(): Transform
  • sortArrays(predicate: Predicate): Transform
  • sortObjects(): Transform
  • sortObjects(predicate: Predicate): Transform

format-jsonc's People

Contributors

mattinsler avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.