codepolish

1.0.15 • Public • Published



CodePolish


CodePolish.js

Beautify your code, Elevate your projects

A npm package written on node to beautify your code be it any tech specific, be it JSON, JS, YAML, Python or JAVA extension files.

Installation

You can install CodePolish using:

npm i codepolish

or

npm install codepolish

Usage

Basic Usage

Now, let's say we have a file: sample.js

// sample.js
function greet(name) {
return `Hello, ${name}!`;
}console.log(greet('Ankit Guria'));

Some dependencies maybe required, like:

npm install yaml

As the package also supports .yaml files. Now just head to the directory of this file and run this command on the console:

node -e "require('codepolish').beautifyJS('sample.js')"

Similarly, a sample.json

// sample.json
{"name":"Ankit Guria","age":25,"city":"India"}

Now just head to the console:

node -e "require('codepolish').beautifyJSON('sample.json')"

And the below screenshot can be seen as it is on the console:

consoleprompt

(Examples)

Test1: Playing with Python files, beautifying .py

OutputImage1

node -e "require('codepolish').beautifyPython('sample.py')"

Output:

OutputImage12

Test2: Playing with JS files, beautifying .js

OutputImage1

node -e "require('codepolish').beautifyJS('sample.js')"

Output:

OutputImage12

Test3: Playing with JAVA files, beautifying .java

OutputImage1

node -e "require('codepolish').beautifyJava('sample.java')"

Output:

OutputImage12

Test4: Playing with JSONs, beautifying JSON Linters

OutputImage1

node -e "require('codepolish').beautifyJSON('sample.json')"

Output:

OutputImage12

Dependencies

npm install require and npm install js-yaml

Steps for a layman(Playground)

  1. Create a new project:

npm init

This command will create a package.json dependencies for your test file.

// package.json
{
  "name": "codepolish",
  "version": "1.0.2",
  "description": "Beautify your code, Elevate your projects",
  "main": "index.cjs",
  "type": "commonjs",
  "directories": {
    "lib": "lib"
  },
  "scripts": {
    "test": "node --experimental-modules test.cjs  "
  },
  "funding": {
    "type": "individual",
    "url": "https://github.com/sponsors/ankit142"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/ankit142/CodePolish.git"
  },
  "bugs": {
    "url": "https://github.com/ankit142/CodePolish/issues"
  },
  "homepage": "https://github.com/ankit142/CodePolish#readme",
  "author": "Ankit Guria",
  "license": "MIT",
  "dependencies": {
    "js-yaml": "^4.1.0",
    "require": "^2.4.20"
  }
}
  1. A new file like - "test.cjs" to be created. Here is the sample code:
// test.cjs
const { beautifyJSON, beautifyYAML, beautifyJS, beautifyPython, beautifyJava } = require('./index.cjs');


// Paths to the unformatted example files
const filePathJSON = './test/example.json';
const filePathYAML = './test/example.yaml';
const filePathJS = './test/example.js';
const filePathPython = './test/example.py';
const filePathJava = './test/example.java';

// Test beautify functions
beautifyJSON(filePathJSON);
beautifyYAML(filePathYAML);
beautifyJS(filePathJS);
beautifyPython(filePathPython);
beautifyJava(filePathJava);

console.log('Beautification completed successfully!');
  1. Now run this file, and here you go. node --experimental-modules test.cjs

  2. Play and enjoy more with custom console log statements or something else. The output should be something like this:

OutputImage13

Contributing

Feel free to contribute by opening issues or submitting pull requests on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Package Sidebar

Install

npm i codepolish

Weekly Downloads

281

Version

1.0.15

License

MIT

Unpacked Size

690 kB

Total Files

32

Last publish

Collaborators

  • ankitguria142