@naturalcycles/nodejs-lib 14.2.0 → 14.3.0

package/dist/fs/fs2.d.ts

@@ -41,6 +41,7 @@ declare class FS2 {
     outputFileAsync(filePath: string, data: string | Buffer): Promise<void>;
     pathExists(filePath: string): boolean;
     pathExistsAsync(filePath: string): Promise<boolean>;
+    requireFileToExist(filePath: string): void;
     ensureDir(dirPath: string): void;
     ensureDirAsync(dirPath: string): Promise<void>;
     ensureFile(filePath: string): void;

package/dist/fs/fs2.js

@@ -21,7 +21,6 @@ import { _isTruthy, _jsonParse } from '@naturalcycles/js-lib';
 import yaml from 'js-yaml';
 import { transformToNDJson } from '../stream/ndjson/transformToNDJson.js';
 import { transformSplitOnNewline } from '../stream/transform/transformSplit.js';
-import { requireFileToExist } from '../util/env.util.js';
 /**
  * fs2 conveniently groups filesystem functions together.
  * Supposed to be almost a drop-in replacement for these things together:
@@ -137,6 +136,11 @@ class FS2 {
             return false;
         }
     }
+    requireFileToExist(filePath) {
+        if (!fs.existsSync(filePath)) {
+            throw new Error(`Required file should exist: ${filePath}`);
+        }
+    }
     ensureDir(dirPath) {
         fs.mkdirSync(dirPath, {
             mode: 0o777,
@@ -303,7 +307,7 @@ class FS2 {
     ])
      */
     createReadStreamAsNDJSON(inputPath) {
-        requireFileToExist(inputPath);
+        this.requireFileToExist(inputPath);
         let stream = fs
             .createReadStream(inputPath, {
             highWaterMark: 64 * 1024, // no observed speedup

package/dist/script/runScript.js

@@ -76,7 +76,7 @@ function checkAndlogEnvironment() {
         '\n' +
         formatObject({
             NODE_OPTIONS: NODE_OPTIONS || 'not defined',
-            TZ,
+            TZ: TZ || 'not defined',
         })));
     if (!NODE_OPTIONS) {
         console.warn(`NODE_OPTIONS env variable is not defined. You may run into out-of-memory issues when running memory-intensive scripts. It's recommended to set it to:\n--max-old-space-size=12000`);
@@ -84,15 +84,17 @@ function checkAndlogEnvironment() {
     else if (NODE_OPTIONS.includes('max_old')) {
         console.warn(`It looks like you're using "max_old_space_size" syntax with underscores instead of dashes - it's WRONG and doesn't work in environment variables. Strongly advised to rename it to "max-old-space-size"`);
     }
-    if (!TZ) {
-        console.error([
-            '!!! TZ environment variable is required to be set, but was not set.',
-            'The runScript will exit and not continue further because of that,',
-            'please ensure the TZ variable and try again.',
-            'If you are running locally, you can add TZ=UTC to the local .env file.',
-        ].join('\n'));
-        process.exit(1);
-    }
+    // if (!TZ) {
+    //   console.error(
+    //     [
+    //       '!!! TZ environment variable is required to be set, but was not set.',
+    //       'The runScript will exit and not continue further because of that,',
+    //       'please ensure the TZ variable and try again.',
+    //       'If you are running locally, you can add TZ=UTC to the local .env file.',
+    //     ].join('\n'),
+    //   )
+    //   process.exit(1)
+    // }
 }
 function formatObject(obj) {
     return Object.entries(obj)

package/dist/util/env.util.d.ts

@@ -10,4 +10,7 @@ import type { ValuesOf } from '@naturalcycles/js-lib';
 export declare function requireEnvKeys<T extends readonly string[]>(...keys: T): {
     [k in ValuesOf<T>]: string;
 };
+/**
+ * @deprecated use fs2.requireFileToExist
+ */
 export declare function requireFileToExist(filePath: string): void;

package/dist/util/env.util.js

@@ -1,5 +1,5 @@
 import 'dotenv/config'; // ensure .env is read before requiring keys
-import { existsSync } from 'node:fs';
+import { fs2 } from '../fs/fs2.js';
 /**
  * @example
  *
@@ -17,8 +17,9 @@ export function requireEnvKeys(...keys) {
         return r;
     }, {});
 }
+/**
+ * @deprecated use fs2.requireFileToExist
+ */
 export function requireFileToExist(filePath) {
-    if (!existsSync(filePath)) {
-        throw new Error(`Required file should exist: ${filePath}`);
-    }
+    fs2.requireFileToExist(filePath);
 }

package/dist/validation/ajv/ajvSchema.js

@@ -1,7 +1,6 @@
 import { _filterNullishValues, _isObject, _substringBefore, JsonSchemaAnyBuilder, } from '@naturalcycles/js-lib';
 import { fs2 } from '../../fs/fs2.js';
 import { _inspect } from '../../string/inspect.js';
-import { requireFileToExist } from '../../util/env.util.js';
 import { AjvValidationError } from './ajvValidationError.js';
 import { getAjv } from './getAjv.js';
 /**
@@ -58,7 +57,7 @@ export class AjvSchema {
      * Convenient method that just does fs.readFileSync for you.
      */
     static readJsonSync(filePath, cfg = {}) {
-        requireFileToExist(filePath);
+        fs2.requireFileToExist(filePath);
         const schema = fs2.readJson(filePath);
         return new AjvSchema(schema, cfg);
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "14.2.0",
+  "version": "14.3.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",

package/src/fs/fs2.ts

@@ -25,7 +25,6 @@ import yaml from 'js-yaml'
 import { transformToNDJson } from '../stream/ndjson/transformToNDJson.js'
 import type { ReadableTyped, TransformTyped } from '../stream/stream.model.js'
 import { transformSplitOnNewline } from '../stream/transform/transformSplit.js'
-import { requireFileToExist } from '../util/env.util.js'
 
 /**
  * fs2 conveniently groups filesystem functions together.
@@ -168,6 +167,12 @@ class FS2 {
     }
   }
 
+  requireFileToExist(filePath: string): void {
+    if (!fs.existsSync(filePath)) {
+      throw new Error(`Required file should exist: ${filePath}`)
+    }
+  }
+
   ensureDir(dirPath: string): void {
     fs.mkdirSync(dirPath, {
       mode: 0o777,
@@ -350,7 +355,7 @@ class FS2 {
   ])
    */
   createReadStreamAsNDJSON<ROW = any>(inputPath: string): ReadableTyped<ROW> {
-    requireFileToExist(inputPath)
+    this.requireFileToExist(inputPath)
 
     let stream: ReadableTyped<ROW> = fs
       .createReadStream(inputPath, {

package/src/script/runScript.ts

@@ -113,7 +113,7 @@ function checkAndlogEnvironment(): void {
         '\n' +
         formatObject({
           NODE_OPTIONS: NODE_OPTIONS || 'not defined',
-          TZ,
+          TZ: TZ || 'not defined',
         }),
     ),
   )
@@ -128,17 +128,17 @@ function checkAndlogEnvironment(): void {
     )
   }
 
-  if (!TZ) {
-    console.error(
-      [
-        '!!! TZ environment variable is required to be set, but was not set.',
-        'The runScript will exit and not continue further because of that,',
-        'please ensure the TZ variable and try again.',
-        'If you are running locally, you can add TZ=UTC to the local .env file.',
-      ].join('\n'),
-    )
-    process.exit(1)
-  }
+  // if (!TZ) {
+  //   console.error(
+  //     [
+  //       '!!! TZ environment variable is required to be set, but was not set.',
+  //       'The runScript will exit and not continue further because of that,',
+  //       'please ensure the TZ variable and try again.',
+  //       'If you are running locally, you can add TZ=UTC to the local .env file.',
+  //     ].join('\n'),
+  //   )
+  //   process.exit(1)
+  // }
 }
 
 function formatObject(obj: AnyObject): string {

package/src/util/env.util.ts

@@ -1,6 +1,6 @@
 import 'dotenv/config' // ensure .env is read before requiring keys
-import { existsSync } from 'node:fs'
 import type { ValuesOf } from '@naturalcycles/js-lib'
+import { fs2 } from '../fs/fs2.js'
 
 /**
  * @example
@@ -24,8 +24,9 @@ export function requireEnvKeys<T extends readonly string[]>(
   )
 }
 
+/**
+ * @deprecated use fs2.requireFileToExist
+ */
 export function requireFileToExist(filePath: string): void {
-  if (!existsSync(filePath)) {
-    throw new Error(`Required file should exist: ${filePath}`)
-  }
+  fs2.requireFileToExist(filePath)
 }

package/src/validation/ajv/ajvSchema.ts

@@ -8,7 +8,6 @@ import {
 import type { Ajv, ValidateFunction } from 'ajv'
 import { fs2 } from '../../fs/fs2.js'
 import { _inspect } from '../../string/inspect.js'
-import { requireFileToExist } from '../../util/env.util.js'
 import { AjvValidationError } from './ajvValidationError.js'
 import { getAjv } from './getAjv.js'
 
@@ -133,7 +132,7 @@ export class AjvSchema<T = unknown> {
     filePath: string,
     cfg: Partial<AjvSchemaCfg> = {},
   ): AjvSchema<T> {
-    requireFileToExist(filePath)
+    fs2.requireFileToExist(filePath)
     const schema = fs2.readJson<JsonSchema<T>>(filePath)
     return new AjvSchema<T>(schema, cfg)
   }