npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ccatjs

v4.1.1

Published

Concatenate files using in-file @import: statements.

Downloads

16

Readme

ccatjs

Concatenate files using in-file @import: statements.

Prerequisites

NodeJS and npm installed.

Installing

Install the ccatjs package using npm:

npm install ccatjs -g

Usage

Assume a project containing multiple files in multiple directories.

To include a file inside another, use @import:(file.js) on a (comment) line.

Path

IMPORTANT: The path specified in the @import: statement must be relative to the containing file.

js

// @import:(file.js)

html

<!-- @import:(file.html) -->

css

/* @import:(file.css) */

etc

@import:(file.txt) 

As long as the string @import:(<yourfile>) is found the line gets replaced by the referenced file content.

Example: (see test/ folder in repository)

src/main.js

// @import:(helpers/strings.js)
// @import:(helpers/arrays.js)
function main() {
    var specialString = getString();
    var specialArray = getSpecialArray();
}

src/helpers/strings.js

function getString() {
    return 'birds' + getString2();
}
// @import:(strings2.js)

src/helpers/strings2.js

function getString2() {
    return 'aura';
}

src/helpers/arrays.js

function getSpecialArray() {
    var a = [1,2,3];
    return a;
}

Options

-u or --unique          Validates each file import to not be imported more than once.

-s or --silent          When successful do not print any output message.
    
-v or --version         Prints the current version number.

Running ccatjs

ccatjs <entryFile> <destFile>

In this example:

ccatjs src/main.js dist/out.js

Result:

dist/out.js

function getString() {
    return 'birds' + getString2();
}
function getString2() {
    return 'aura';
}
function getSpecialArray() {
    var a = [1,2,3];
    return a;
}
function main() {
    var specialString = getString();
    var specialArray = getSpecialArray();
}

Output results

Success:

+ Successfully concatenated 4 entries. 

Errors:

Error checks:

  • Syntax.
  • Non existing references.
  • Imported before (optional with -u or --unique).
  • Circular reference.

Errors are reported including filename and line number.

- File reference malformed. Correct syntax is: @import:(path/file.ext). Notice parenthesis. File `main.js`. Line: `19`.

- File reference: `../file3.js` cannot be found. File `main.js`. Line: `22`. 

- File reference: `../file4.js` imported before. File `main.js`. Line: `27`. 

- File reference: `../file4.js` causes circular reference. File `main.js`. Line: `29`. 

License

This project is licensed under the MIT license.