yini-parser 1.0.0-alpha.2 → 1.0.0-alpha.4

package/README.md

@@ -59,9 +59,10 @@ import YINI from 'yini-parser';
 
 // Parse from string.
 const config = YINI.parse(`
-^ Database
-host = localhost
-port = 5432
+    ^ App
+    title = "My App Title"
+    items = 25
+    isDarkTheme = OFF
 `);
 
 // Parse from file.
@@ -105,10 +106,11 @@ Returns a JavaScript object representing the parsed YINI configuration file.
 ## Example Output
 ```js
 {
-  Database: {
-    host: "localhost",
-    port: 5432
-  }
+   App:{
+      title: "My App Title",
+      items: 25,
+      isDarkTheme: false
+   }
 }
 ```
 
@@ -127,5 +129,4 @@ In this project on GitHub, the `libs` directory contains third party software an
 
 ---
 
-> ~ **YINI ≡**  
-> [https://yini-lang.org](https://yini-lang.org)
+~ **YINI ≡** • [https://yini-lang.org](https://yini-lang.org)

package/dist/config/env.d.ts

@@ -11,10 +11,24 @@ type TNodeEnv = 'development' | 'production' | 'test';
  * @note Since this is a library (as opposed to a Web/App), we don't use "staging".
  */
 type TAppEnv = 'local' | 'ci' | 'production';
-declare const NODE_ENV: TNodeEnv;
-declare const APP_ENV: TAppEnv;
-export declare const isDebug: () => boolean;
+declare const localNodeEnv: TNodeEnv;
+declare const localAppEnv: TAppEnv;
+/** Are we running in the environment "development"? Will be based on the (global) environment variable process.env.NODE_ENV. */
+export declare const isDevEnv: () => boolean;
+/** Are we running in the environment "production"? Will be based on the (global) environment variable process.env.NODE_ENV. */
+export declare const isProdEnv: () => boolean;
+/** Are we running in the environment "test"? Will be based on the (global) variable process.env.NODE_ENV. */
+export declare const isTestEnv: () => boolean;
+/** Will be based on the local argument when this process was launched.
+ * @returns True if the DEV flag is set.
+ * @example npm run start -- isDev=1
+ * @example node dist/index.js isDev=1
+ */
 export declare const isDev: () => boolean;
-export declare const isProd: () => boolean;
-export declare const isTest: () => boolean;
-export { NODE_ENV, APP_ENV };
+/** Will be based on the local argument when this process was launched.
+ * @returns True if the DEBUG flag is set.
+ * @example npm run start -- isDebug=1
+ * @example node dist/index.js isDebug=1
+ */
+export declare const isDebug: () => boolean;
+export { localNodeEnv, localAppEnv };

package/dist/config/env.js

@@ -1,15 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.APP_ENV = exports.NODE_ENV = exports.isTest = exports.isProd = exports.isDev = exports.isDebug = void 0;
-const NODE_ENV = (process.env.NODE_ENV || 'development');
-exports.NODE_ENV = NODE_ENV;
-const APP_ENV = (process.env.APP_ENV || 'local');
-exports.APP_ENV = APP_ENV;
-const isDebug = () => !!process.env.IS_DEBUG;
-exports.isDebug = isDebug;
-const isDev = () => NODE_ENV === 'development';
+exports.localAppEnv = exports.localNodeEnv = exports.isDebug = exports.isDev = exports.isTestEnv = exports.isProdEnv = exports.isDevEnv = void 0;
+const localNodeEnv = (process.env.NODE_ENV || 'production');
+exports.localNodeEnv = localNodeEnv;
+const localAppEnv = (process.env.APP_ENV || 'production');
+exports.localAppEnv = localAppEnv;
+// export const initEnvs = () => {
+//     const localNodeEnv = (process.env.NODE_ENV || 'production') as TNodeEnv
+//     const localAppEnv = (process.env?.APP_ENV || 'production') as TAppEnv
+//     return { localNodeEnv, localAppEnv }
+// }
+// const { localNodeEnv, localAppEnv } = initEnvs()
+/** Are we running in the environment "development"? Will be based on the (global) environment variable process.env.NODE_ENV. */
+const isDevEnv = () => localNodeEnv === 'development';
+exports.isDevEnv = isDevEnv;
+/** Are we running in the environment "production"? Will be based on the (global) environment variable process.env.NODE_ENV. */
+const isProdEnv = () => localNodeEnv === 'production';
+exports.isProdEnv = isProdEnv;
+/** Are we running in the environment "test"? Will be based on the (global) variable process.env.NODE_ENV. */
+const isTestEnv = () => localNodeEnv === 'test';
+exports.isTestEnv = isTestEnv;
+/** Will be based on the local argument when this process was launched.
+ * @returns True if the DEV flag is set.
+ * @example npm run start -- isDev=1
+ * @example node dist/index.js isDev=1
+ */
+const isDev = () => {
+    const len = process.argv.length;
+    // NOTE: We will start with index 2, since the first element will be
+    // execPath. The second element will be the path to the
+    // JavaScript file being executed.
+    for (let i = 2; i < len; i++) {
+        const val = process.argv[i] || '';
+        if (val.toLowerCase() === 'isdev=1' ||
+            val.toLowerCase() === 'isdev=true') {
+            return true;
+        }
+    }
+    return false;
+};
 exports.isDev = isDev;
-const isProd = () => NODE_ENV === 'production';
-exports.isProd = isProd;
-const isTest = () => NODE_ENV === 'test';
-exports.isTest = isTest;
+/** Will be based on the local argument when this process was launched.
+ * @returns True if the DEBUG flag is set.
+ * @example npm run start -- isDebug=1
+ * @example node dist/index.js isDebug=1
+ */
+const isDebug = () => {
+    const len = process.argv.length;
+    // NOTE: We will start with index 2, since the first element will be
+    // execPath. The second element will be the path to the
+    // JavaScript file being executed.
+    for (let i = 2; i < len; i++) {
+        const val = process.argv[i] || '';
+        if (val.toLowerCase() === 'isdebug=1' ||
+            val.toLowerCase() === 'isdebug=true') {
+            return true;
+        }
+    }
+    return false;
+};
+exports.isDebug = isDebug;

package/dist/core/types.d.ts

@@ -21,6 +21,16 @@ export interface IParseMetaData {
         errors: null | number;
         warnings: null | number;
         infoAndNotices: null | number;
+        envs: {
+            NODE_ENV: undefined | string;
+            APP_ENV: undefined | string;
+            libNodeEnv: undefined | string;
+            libAppEnv: undefined | string;
+        };
+        libFlags: {
+            isDev: boolean;
+            isDebug: boolean;
+        };
     };
     timing?: {
         totalMs: null | number;

package/dist/index.js

@@ -21,16 +21,24 @@ const system_1 = require("./utils/system");
 const YINI_1 = __importDefault(require("./YINI"));
 var YINI_2 = require("./YINI");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(YINI_2).default; } });
-if ((0, env_1.isDev)() || (0, env_1.isDebug)()) {
-    console.log('process.env?.NODE_ENV = ' + ((_a = process.env) === null || _a === void 0 ? void 0 : _a.NODE_ENV));
-    console.log('process.env?.APP_ENV  = ' + ((_b = process.env) === null || _b === void 0 ? void 0 : _b.APP_ENV));
-    console.log('process.env?.IS_DEBUG = ' + ((_c = process.env) === null || _c === void 0 ? void 0 : _c.IS_DEBUG));
-}
-// console.log('NODE_ENV = ' + NODE_ENV)
-// console.log('APP_ENV = ' + APP_ENV)
 (0, system_1.debugPrint)();
 (0, system_1.debugPrint)('-> Entered index.ts');
 (0, system_1.debugPrint)();
+if ((0, env_1.isDev)() || (0, env_1.isDebug)()) {
+    console.log(`process.env?.NODE_ENV = '${(_a = process.env) === null || _a === void 0 ? void 0 : _a.NODE_ENV}'`);
+    console.log(`process.env?.APP_ENV  = '${(_b = process.env) === null || _b === void 0 ? void 0 : _b.APP_ENV}'`);
+    console.log(`process.env?.IS_DEBUG = '${(_c = process.env) === null || _c === void 0 ? void 0 : _c.IS_DEBUG}'`);
+    (0, system_1.debugPrint)();
+    console.log(`localNodeEnv = '${env_1.localNodeEnv}'`);
+    console.log(` localAppEnv = '${env_1.localAppEnv}'`);
+    console.log(' isProdEnv() = ' + (0, env_1.isProdEnv)());
+    console.log('  isDevEnv() = ' + (0, env_1.isDevEnv)());
+    console.log(' isTestEnv() = ' + (0, env_1.isTestEnv)());
+    console.log();
+    console.log('     isDev() = ' + (0, env_1.isDev)());
+    console.log('   isDebug() = ' + (0, env_1.isDebug)());
+    console.log();
+}
 const debugTestObj = {
     name: 'e_test',
     lang: 'TypeScript',
@@ -38,7 +46,7 @@ const debugTestObj = {
 (0, system_1.debugPrint)('debugTestObj:');
 (0, system_1.debugPrint)(debugTestObj);
 (0, system_1.debugPrint)();
-if ((0, env_1.isProd)()) {
+if ((0, env_1.isProdEnv)()) {
     // Do nothing, and exit.
 }
 else {
@@ -89,7 +97,7 @@ listItems = ["a", "b", "c"]
     //     console.debug(invalidInput1)
     // }
     // YINI.parse(invalidInput1)
-    if (env_1.APP_ENV === 'local' && env_1.NODE_ENV !== 'test') {
+    if (env_1.localAppEnv === 'local' && env_1.localNodeEnv !== 'test') {
         /*
         YINI.parse(`
 --^ Section0

package/dist/parseEntry.js

@@ -127,6 +127,16 @@ const parseMain = (yiniContent, options = {
             errors: errorHandler.getNumOfErrors(),
             warnings: errorHandler.getNumOfWarnings(),
             infoAndNotices: errorHandler.getNumOfInfoAndNotices(),
+            envs: {
+                NODE_ENV: process.env.NODE_ENV,
+                APP_ENV: process.env.APP_ENV,
+                libNodeEnv: env_1.localNodeEnv,
+                libAppEnv: env_1.localAppEnv,
+            },
+            libFlags: {
+                isDev: (0, env_1.isDev)(),
+                isDebug: (0, env_1.isDebug)(),
+            },
         };
     }
     if (options.isWithTiming) {

package/dist/utils/system.js

@@ -11,11 +11,11 @@ const debugPrint = (str = '') => {
 };
 exports.debugPrint = debugPrint;
 const devPrint = (str = '') => {
-    (0, env_1.isDev)() && !(0, env_1.isTest)() && console.log('DEV: ' + str);
+    (0, env_1.isDev)() && !(0, env_1.isTestEnv)() && console.log('DEV: ' + str);
 };
 exports.devPrint = devPrint;
 const printObject = (obj) => {
-    if ((0, env_1.isProd)() || ((0, env_1.isTest)() && !(0, env_1.isDebug)()))
+    if ((0, env_1.isProdEnv)() || ((0, env_1.isTestEnv)() && !(0, env_1.isDebug)()))
         return;
     const str = JSON.stringify(obj, null, 4);
     console.log(str);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "yini-parser",
-    "version": "1.0.0-alpha.2",
+    "version": "1.0.0-alpha.4",
     "description": "YINI parser for JavaScript/TypeScript, an INI-inspired configuration format, meant to be readable, and easy to use.",
     "keywords": [
         "read",
@@ -36,19 +36,19 @@
     },
     "private": false,
     "scripts": {
-        "start": "cross-env NODE_ENV=production APP_ENV=production node dist/index.js",
-        "start:debug": "cross-env IS_DEBUG=1 npm run start",
-        "start:dev": "cross-env NODE_ENV=development APP_ENV=local ts-node src/index.ts",
-        "start:dev:debug": "cross-env IS_DEBUG=1 npm run start:dev",
+        "start": "npm run build && node dist/index.js",
+        "start:debug": "npm run start -- isDebug=1",
+        "start:dev": "cross-env NODE_ENV=development APP_ENV=local ts-node src/index.ts isDev=1",
+        "start:dev:debug": "cross-env npm run start:dev -- isDebug=1",
         "start-w-clean": "npm run tsc && npm run clean:ts-js && npm run start:dev",
         "test": "cross-env NODE_ENV=test APP_ENV=local jest --bail --verbose --runInBand",
-        "test:debug": "cross-env IS_DEBUG=1 npm run test",
+        "test:debug": "cross-env npm run test -- --isDebug=1",
         "test:smoke": "cross-env NODE_ENV=test APP_ENV=local jest tests/smoke --bail --verbose --runInBand",
         "test:unit": "cross-env NODE_ENV=test APP_ENV=local jest tests/unit --bail --verbose --runInBand",
         "test:integr": "cross-env NODE_ENV=test APP_ENV=local jest tests/integration --bail --verbose --runInBand",
-        "test:smoke:debug": "cross-env IS_DEBUG=1 npm run test:smoke",
-        "test:unit:debug": "cross-env IS_DEBUG=1 npm run test:unit",
-        "test:integr:debug": "cross-env IS_DEBUG=1 npm run test:integr",
+        "test:smoke:debug": "cross-env npm run test:smoke -- --isDebug=1",
+        "test:unit:debug": "cross-env npm run test:unit -- --isDebug=1",
+        "test:integr:debug": "cross-env npm run test:integr -- --isDebug=1",
         "ci:test": "cross-env NODE_ENV=test APP_ENV=ci jest --verbose --runInBand",
         "ci:test:smoke": "cross-env NODE_ENV=test APP_ENV=ci jest tests/smoke --verbose --runInBand",
         "tsc": "npx tsc -p ./tsconfig.json",