- Big news!Introducing Socket AI - ChatGPT-Powered Threat Analysis. Learn more →
file-directives
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 1,504
- increased by36.85%
Weekly downloads
Readme
#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
Utility to specify pre-package directives to allow automatic code stripping
The npm package file-directives receives a total of 1,487 weekly downloads. As such, file-directives popularity was classified as popular.
We found that file-directives demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.