preprocess-mallowigi

v2.1.1

Preprocess directives in HTML, JavaScript, etc directives based off variable context For more information about how to use this package see README

Latest version published 10 years ago

License: Unrecognized

NPM

GitHub

Package Health Score

48 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.1.1	\|	11/2014	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unrecognized

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (0)

GitHub Stars: 366
Forks: 80
Contributors: 30

Direct Usage Popularity

The npm package preprocess-mallowigi receives a total of 0 downloads a week. As such, we scored preprocess-mallowigi popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package preprocess-mallowigi, we found that it has been starred 366 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the preprocess-mallowigi repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like preprocess-mallowigi is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 45
Open PR: 12
Last Release: 10 years ago
Last Commit: 4 years ago

Further analysis of the maintenance status of preprocess-mallowigi based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for preprocess-mallowigi is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 0.10.0

Age: 10 years
Dependencies: 0 Direct
Versions: 2
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

preprocess-mallowigi has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

preprocess

Preprocess HTML, JavaScript, and other files with directives based off custom or ENV configuration

What does it look like?


  <title>Your App

  &lt;!-- @if NODE_ENV='production' --&gt;
  &lt;script src="some/production/lib/like/analytics.js"&gt;&lt;/script&gt;
  &lt;!-- @endif --&gt;

&lt;/head&gt;
&lt;body&gt;
  &lt;!-- @ifdef DEBUG --&gt;
  &lt;h1&gt;Debugging mode - &lt;!-- @echo RELEASE_TAG --&gt; &lt;/h1&gt;
  &lt;!-- @endif --&gt;
  &lt;p&gt;
  &lt;!-- @include welcome_message.txt --&gt;
  &lt;/p&gt;
&lt;/body&gt;

var configValue = '/* @echo FOO */' || 'default value';

// @ifdef DEBUG
someDebuggingCall()
// @endif

Directive syntax

Basic syntax

The most basic usage is for files that only have two states, non-processed and processed. In this case, your @exclude directives are removed after preprocessing

&lt;body&gt;
    &lt;!-- @exclude --&gt;
    &lt;header&gt;You're on dev!&lt;/header&gt;
    &lt;!-- @endexclude --&gt;
&lt;/body&gt;

After build

&lt;body&gt;
&lt;/body&gt;

Advanced directives

@if VAR='value' / @endif This will include the enclosed block if your test passes
@ifdef VAR / @endif This will include the enclosed block if VAR is defined (typeof !== 'undefined')
@ifndef VAR / @endif This will include the enclosed block if VAR is not defined (typeof === 'undefined')
@include This will include the source from an external file. If the included source ends with a newline then the following line will be space indented to the level the @include was found.
@exclude / @endexclude This will remove the enclosed block upon processing
@echo VAR This will include the environment variable VAR into your source
@exec FUNCTION([param1, param2...]) This will execute the environment FUNCTION with is parameters and echo the result into your source. The parameter could be a string or a reference to another environment variable.

Extended html Syntax

This is useful for more fine grained control of your files over multiple environment configurations. You have access to simple tests of any variable within the context (or ENV, if not supplied)

&lt;body&gt;
    &lt;!-- @if NODE_ENV!='production' --&gt;
    &lt;header&gt;You're on dev!&lt;/header&gt;
    &lt;!-- @endif --&gt;

    &lt;!-- @if NODE_ENV='production' --&gt;
    &lt;script src="some/production/javascript.js"&gt;&lt;/script&gt;
    &lt;!-- @endif --&gt;

    &lt;script&gt;
    var fingerprint = '&lt;!-- @echo COMMIT_HASH --&gt;' || 'DEFAULT';
    &lt;/script&gt;

    &lt;script src="&lt;!-- @exec static_path('another/production/javascript.js') --&gt;"&gt;&lt;/script&gt;
&lt;/body&gt;

With a NODE_ENV set to production and 0xDEADBEEF in COMMIT_HASH this will be built to look like

&lt;body&gt;
    &lt;script src="some/production/javascript.js"&gt;&lt;/script&gt;

    &lt;script&gt;
    var fingerprint = '0xDEADBEEF' || 'DEFAULT';
    &lt;/script&gt;

    &lt;script src="https://cdn2.my.domain.com/another/javascript.js') --&gt;"&gt;&lt;/script&gt;
&lt;/body&gt;

With NODE_ENV not set or set to dev and nothing in COMMIT_HASH, the built file will be

&lt;body&gt;
    &lt;header&gt;You're on dev!&lt;/header&gt;

    &lt;script&gt;
    var fingerprint = '' || 'DEFAULT';
    &lt;/script&gt;

    &lt;script src="https://localhost/myapp/statics/another/javascript.js') --&gt;"&gt;&lt;/script&gt;
&lt;/body&gt;

You can also have conditional blocks that are hidden by default by using the fictional !> end tag instead of --> after your condition:

&lt;!-- @if true !&gt;
&lt;p&gt;Process was run!&lt;/p&gt;
&lt;!-- @endif --&gt;

JavaScript, CSS, C, Java Syntax

Extended syntax below, but will work without specifying a test

normalFunction();
//@exclude
superExpensiveDebugFunction()
//@endexclude

'/* @echo USERNAME */'

anotherFunction();

Built with a NODE_ENV of production :

normalFunction();

'jsoverson'

anotherFunction();

Like HTML, you can have conditional blocks that are hidden by default by ending the directive with a ** instead of */

angular.module('myModule', ['dep1'
    , 'dep2'
    /* @if NODE_ENV='production' **
    , 'prod_dep'
    /* @endif */
    /* @exclude **
    , 'debug_dep'
    /* @endexclude */
]);

Note: It doesn't work with simple style comments.

CSS example

body {
/* @if NODE_ENV=='development' */
  background-color: red;
/* @endif */

}
// @include util.css

(CSS preprocessing supports single line comment style directives)

Shell, PHP

#!/bin/bash

# @include util.sh

Configuration and Usage

Install via npm

$ npm install --save preprocess

Use the exposed preprocess method or the convenience file functions. The context, by default, is the current ENV config the process (process.env)


var pp = require('preprocess');

var text = 'Hi, I am &lt;!-- @echo USERNAME --&gt;';

pp.preprocess(text);
// -&gt; Hi, I am jsoverson

pp.preprocess(text, {USERNAME : "Bob"});
// -&gt; Hi, I am Bob

// specify the format to use for the directives as the third parameter
pp.preprocess(text, {USERNAME : "Bob"}, 'html');
// -&gt; Hi, I am Bob

// Simple wrapper around fs.readFile and fs.writeFile
pp.preprocessFile(src, dest, context, callback);

// Simple wrapper around fs.readFileSync and fs.writeFileSync
pp.preprocessFileSync(src, dest, context);

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using jshint

Release History

2.1.0 Added automatic support for numerous formats, merged @exec, hidden by default html tags, added simple directives
2.0.0 Added ability to echo strings, added conditional comments, removed lodash, merged 17, 13, 15, 16
1.2.0 Added processing for hash-style comments (via @marsch). Added more file aliases.
1.1.0 Added deep inclusion, fixed sequential ifs
1.0.1 Fixed multiple inline echo statements
1.0.0 Pulled from grunt-preprocess to stand alone

License

Written by Jarrod Overson

Licensed under the Apache 2.0 license.

preprocess-mallowigi development dependencies

grunt-contrib-jshint grunt grunt-contrib-nodeunit

FAQs

What is preprocess-mallowigi?

Preprocess directives in HTML, JavaScript, etc directives based off variable context. Visit Snyk Advisor to see a full health score report for preprocess-mallowigi, including popularity, security, maintenance & community analysis.

Is preprocess-mallowigi popular?

We’re still processing downloads data for the npm package preprocess-mallowigi. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is preprocess-mallowigi well maintained?

We found indications that preprocess-mallowigi is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is preprocess-mallowigi safe to use?

The npm package preprocess-mallowigi was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 10 November-2024, at 07:47 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (0)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

preprocess

What does it look like?

Directive syntax

Basic syntax

Advanced directives

Extended html Syntax

JavaScript, CSS, C, Java Syntax

Shell, PHP

Configuration and Usage

Contributing

Release History

License

preprocess-mallowigi development dependencies

FAQs

What is preprocess-mallowigi?

Is preprocess-mallowigi popular?

Is preprocess-mallowigi well maintained?

Is preprocess-mallowigi safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues