Socket
Socket
Sign inDemoInstall

file-directives

Package Overview
Dependencies
7
Maintainers
1
Versions
18
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    file-directives

Utility to specify pre-package directives to allow automatic code stripping


Version published
Weekly downloads
1.5K
increased by4.23%
Maintainers
1
Install size
283 kB
Created
Weekly downloads
 

Readme

Source

#file-directives#

To use this utility use the following command:

npm install file-directives -g

What this utility allows you to do is to auto comment code based on enviroment variable. Following is a common scenario where this is helpful:

//#if [DEV_MODE]
  int bufferSize = 0;
//#endif

//#if [RELEASE_MODE]
  //int bufferSize = 4096;
//#endif

Here DEV_MODE and RELEASE_MODE are environment variables. Before running your bundler or deployer just go to the relevant directory and run:

file-directives RELEASE_MODE node_modules

This will automatically uncomment relevant code and comment the irrelevant one. Following is the syntax:

file-directives comma-separated-env-vars comma-separated-folder-to-ignore

Also, you need to enclose env vars in [] while you use them in code. Following is the directive syntax:

//#if [ENV1] || [ENV2] || [ENV3]

.... relevant code

//#endif

Note: Else is not supported :)

FAQs

Last updated on 09 Nov 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc