DEV Community

ShGI
ShGI

Posted on

Chnp-cli: Code Highlight and Print tool

What is it?

CHNP (Code highlight and print) which is the project I developed in my first year of Diploma for the purpose of code printing where I can use a certain format to create a PDF from my code and it's output.
It was helpful throughout my diploma where I have to submit prints of my code.
You can checkout that repo here

GitHub logo SGI-CAPP-AT2 / code-highlight-n-print

A black & white Code highlighter for hard copy of documentations ...

/README assets/banner.png

code-highlight-n-print

  • A code highlighter for microsoft word and print code problems with there code, output, graphics output, title, filename and watermark
  • A BnW Code highlighter for hard copy of docs

Getting Started


Description of project

Convert your code with highlight into rich text using BnW highlighter

Features

  • Efficient highlighting
  • only two color tones used in highlight
  • line numbering
  • full support for rtf paste in microsoft word & google docs
  • output and code have different blocks
  • can even watermark your name/username

Initiated by SGI-CAPP-AT2 ShGI

Recent fixes

  • added site watermark
  • added session exports for autosave

Sample outputs






What is CHNP Cli?

CHNP is an webapp where I have to copy my code and paste which is very hard to manage in case we've multiple codes for same practical/experiments.
You've to copy them one by one and paste them there.
So, to tackle this problem and make tool more convenient I developed a Command Line application in Nodejs.
You can check the repo here

GitHub logo SGI-CAPP-AT2 / chnp-cli

This tool is cli version for CHNP project which works locally into your computers.

Code Highlight n Print Command Line Interface

This tool is cli version for CHNP project which works locally into your computers.




How it works?

Working of CHNP Cli
CHNP Cli has following major components :

1.Session Object: This is where all of your codes and settings for current working directory is stored. (A Json File)
2.Commands: Currently there are 2 commands details

  1. cohl: It is for operations like exporting or printing the session object i.e. it only reads the session objects.
  2. cohls: It is for operations like editing your style preferences, staging codes for printing and many more i.e. for editing session object

3.Operators: These are the always first arguments passed to commands like to perform add operation we'll use add operator. details

CHNP Cli uses Nodejs as runtime

Installation

Prerequisites

Nodejs is only Prerequisites you have to install
You can install it from here

Install

After Installing the Nodejs you will type following command into terminal in any directory.

npm install -g chnp-cli
Enter fullscreen mode Exit fullscreen mode

This will install the CHNP-Cli

How to use it ?

STEP 1: Create Session Object

Always you've to create session object so to do that you can use following command

cohls create "<MyObjectName>""
Enter fullscreen mode Exit fullscreen mode

STEP 2: Sepcify file name

Cohls will ask you for filename enter like following

cohls create "JavaSessionObject"
Enter filename while adding: $1.java
Enter fullscreen mode Exit fullscreen mode

here $1 will be replaced with 2nd arg passed while add operator because 1st arg will alway be the add operator.

STEP 3: Specify Commands

To Execute Source Code of java we require 2 commands usually which are javac and java.
So, Specify Them As Follows

$ cohls create "JavaSessionObject"
Enter filename while adding: $1.java
Enter commands to run program while adding: 
1. > javac $1.java
2. > java $1
3. > 

Enter fullscreen mode Exit fullscreen mode

Now whenever we've to stage a java file we can use following command

$ cohls add App
Enter fullscreen mode Exit fullscreen mode

Source Code file will be App.java which will produce App.class and wil execute it.

STEP 4: Specify your watermark

Like

$ cohls create "JavaSessionObject"
Enter filename while adding: $1.java
Enter commands to run program while adding: 
1. > javac $1.java
2. > java $1
3. > 
Enter watermark for your codes: CODE_BY_SHUBHAM
Operation is SUCCESSFULL
Enter fullscreen mode Exit fullscreen mode

STEP 5: Add a Java File

You can add your file by using add operator

cohls add App.java
<
YOUR CODE EXECUTION WILL BE HERE
>
OPERATION IS SUCCESSFUL 
Enter fullscreen mode Exit fullscreen mode

Wrapping Up

And that's it for this post,
You can use this project for printing your codes with output.

Made with 💖 by Shubham

Top comments (0)