Code commenting is the practice of sprinkling short, normally single-line notes throughout your code. These notes are called comments. They explain how your program works, and your intentions behind it.Comments don’t have any effect on your program, but they are invaluable for people reading your code.Coders are expected to comment their code to some degree.Code comments are useful for several purposes. A code comment can explain what a particular function does,explain something which might not be obvious to the reader,clarify your intention behind a certain line or block of code,serve as a reminder to change something in the future. Commenting can be very much helpful but whenever we work on a project we create some single line or multiple line comments for understanding the necessity or usability of the current code. These single line or multiple line comments are good during the development phase but not suitable for production. So we will create a script that will completely remove comments from a single file and from a whole project. <h2>Required modules</h2>* glob:To remove comment throughout the project<pre class="ql-syntax" spellcheck="false">npm i glob
</pre>* strip-comments:To remove comment from a single file <pre class="ql-syntax" spellcheck="false">npm i strip-comments
</pre>* prettier(optional if u don't have prettier extension installed in vs code) :removes spaces and refactor the code after the removal of comments<pre class="ql-syntax" spellcheck="false">npm i prettier
</pre> <h2>Initialize the project</h2><pre class="ql-syntax" spellcheck="false">npm init -y
</pre>install the above modules.Create three files `filewithcomments.js` , `script.js` and `allscript.js`.Edit your `package.json` file as below:<pre class="ql-syntax" spellcheck="false">"scripts": {
 "clean": "node script.js",
 "cleanall": "node allscript.js"
 },
</pre> Copy below example code into your `filewithcomments.js` or you can add any code with comments.<pre class="ql-syntax" spellcheck="false"> let a = 5,b = 5;
//a and b declared and initialized with values
const play = () =&gt; console.log(a + b); 
//function to add a and b

play()
//function call
</pre> Copy below code into your `script.js`:<pre class="ql-syntax" spellcheck="false">const fs = require("fs") 
//import fs from node inbuilt methods
const strip = require("strip-comments") 
// import strip from strip-comments module

try {
 let filepath = 'filewithcomments.js'; 
 // declaring file path from which comments should be stripped


 let file = fs.openSync(filepath, "r+") 
 // Using fs openSync method to open the file


 let data = fs.readFileSync(file, "utf8")
 // Using fs readFileSync method to read the file


 let strings = strip(data)
 // Using strip from strip-comments module and passing data


 fs.writeFileSync(filepath, strings)
 // Writing the stripped data back to the filepath


 console.log('Comments from '+filepath+' has been Removed')

} catch (error) {
 console.log(error)
}
</pre>Now we are ready to test our script.Enter the below command in terminal:<pre class="ql-syntax" spellcheck="false">npm run clean
</pre>You'll see the below output:<pre class="ql-syntax" spellcheck="false">cleanScript@1.0.0 clean
 node script.js

Comments from filewithcomments.js has been Removed

</pre>Check your 'filewithcomments.js',You'll see the below output:<pre class="ql-syntax" spellcheck="false">let a = 5,
 b = 5


const play = () =&gt; console.log(a + b)


play()
</pre>That is all for single file. Now copy the below file in `allscript.js`:<pre class="ql-syntax" spellcheck="false">const fs = require("fs")
const strip = require("strip-comments")
const prettier = require("prettier")
var glob = require("glob")


try {
 //glob to search files ignoring node_modules directory 
 glob("**/*.js", { ignore: "**/node_modules/**" }, function (error, files) {
 //forEach loop to iterate array of files
 files.forEach((element) =&gt; {
 //Opening each file inside loop using fs openSync method
 var file = fs.openSync(element, "r+")
 //Reading each file inside loop using fs readFileSync method
 var data = fs.readFileSync(file, "utf8")


 //Stripping comments from each file using strip-comments module
 const strings = strip(data)
 //Formating our files using prettier
 const pretty = prettier.format(strings, { semi: false, parser: "babel" })
 //Writing stripped data back to their original files
 fs.writeFileSync(element, pretty)


 
 console.log('Comments has been Removed from ' + element)
 })
 })
} catch (error) {
 console.log(error)
}
</pre>You can duplicate the file `filewithcomments.js` into `filewithcomments1.js` and `filewithcomments2.js` .Now we can test to remove for all the files in the project.Run the below command:<pre class="ql-syntax" spellcheck="false"> npm run cleanall
</pre>You'll see the below output:<pre class="ql-syntax" spellcheck="false"> cleanScript@1.0.0 cleanall
node allscript.js


Comments has been Removed from allscript.js
Comments has been Removed from filewithcomment1.js
Comments has been Removed from filewithcomment2.js
Comments has been Removed from filewithcomments.js
Comments has been Removed from script.js
</pre> Well done you have succesfully created the script to remove comments.Full code <a href="https://projecthubatblogue.netlify.app/" rel="noopener noreferrer" target="_blank">here</a>

Comment Remover with Javascript

Related blogs

About us: