yini-cli 1.0.0-alpha.2 → 1.0.1-beta.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Gothenburg, Marko K. S. (Sweden via Finland).
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,7 @@
 # YINI-CLI
-Command-line tool for working with YINI configuration files. A human-friendly config format — like INI, but with type-safe values, nested sections, comments, minimal syntax noise, and optional strict mode.
+**Command-line tool for working with YINI configuration files. Validate, inspect, and convert to JSON with pretty output.**
+
+*YINI aims to be a human-friendly config format: like INI, but with type-safe values, nested sections, comments, minimal syntax noise, and optional strict mode.*
 
 [![npm version](https://img.shields.io/npm/v/yini-parser.svg)](https://www.npmjs.com/package/yini-parser) [![All Tests](https://github.com/YINI-lang/yini-cli/actions/workflows/run-all-tests.yml/badge.svg)](https://github.com/YINI-lang/yini-cli/actions/workflows/run-all-tests.yml)
 
@@ -7,30 +9,86 @@ Command-line tool for working with YINI configuration files. A human-friendly co
 
 ## 🙋‍♀️ Why YINI?
 - **YINI is an alternative** to other great config formats like INI, JSON, YAML, XML, and TOML — designed for clarity, simplicity, and straightforward section nesting.
-- **Started as a personal project and a research challenge:** Aiming for something more readable than JSON, more structured than INI, and less surprising than YAML.
+- **Started as a personal project and a research challenge:** Provides structure similar to INI, with features inspired by JSON and YAML.
 - **Built for clarity:**
-    * Easy to read and write for humans, especially for nested sections.
-    * Not too much syntax noise.
-    * Just enough structure for real-world configs.
-- **A little bit of fun and joy:**
-    * Created to scratch our own itch — if you like it too, that's a bonus!
+    * Uses minimal syntax for humans, especially for nested sections.
+    * Uses a concise syntax, aims to not have too much syntax noise.
+    * Supports commonly used configuration structures.
+- *Originated from practical needs **for configuration clarity, simplicity, minimalism, and flexibility**.
 
 ---
 
 ## 💡 What is YINI?
-- **Simple like INI** — but with strong typing, comments, and nested sections.
-- **Easy to read and write** — minimal syntax noise, maximum clarity.
-- **Clear, minimal section nesting** — no painful indentation or long dot-delimited keys.
+- **INI-inspired** — with added support for typing, comments, and nested sections.
+- **Uses minimal syntax** — minimal syntax noise, maximum clarity.
+- Section nesting **without requiring indentation or dot-delimited keys**.
 - **Supports strict and lenient modes**, and all major data types.
-- Both **human-friendly** and **machine-friendly**.
+- Designed for compatibility with both **manual editing** and **automation**.
 - 👉 See [how YINI compares to JSON, YAML, INI, and TOML](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples/compare-formats.md).
 - Want the full syntax reference? See the [YINI Specification](https://github.com/YINI-lang/YINI-spec).
 
 ---
 
+## Intro to YINI Config Format
+**YINI** is a simple and readable configuration format. Sections are defined with `^ SectionName`, and values are assigned using `key = value`. The format supports common data types (same as those found in JSON), including strings, numbers, booleans, nulls, and lists. 
+
+To learn more, see the [Getting Started: Intro to YINI Config Format](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Intro-to-YINI-Config-Format.md) tutorial.
+
+---
+
 ## Usage
 
-### 📤 Output Modes for `yini parse`
+### Installation
+
+1. **Install it globally from npm**  
+    Open your terminal and run:
+    ```
+    npm install -g yini-cli
+    ```
+
+2. **Verify installation**  
+    Run this in your terminal:
+    ```bash
+    yini --version
+    ```
+    Should print the version (e.g., 1.0.0).
+
+    Then you may try:
+    ```bash
+    yini --help
+    ```
+    Should show you the CLI help for YINI.
+
+3. **Test functionality**  
+    Create a simple test file, for example: `config.yini`:
+    ```yini
+    ^ App
+    name = "My App Title"
+    version = "1.2.3"
+    pageSize = 25
+    darkTheme = off
+    ```
+
+    Then run:
+    ```bash
+    yini parse config.yini
+    ```
+
+    Expected result, your CLI should output a parsed version of the config and output something similar to:
+    ```js
+    {
+        App: {
+            name: 'My App Title',
+            version: '1.2.3',
+            pageSize: 25,
+            darkTheme: false
+        }
+    }    
+    ```
+
+---
+
+## 📤 Output Modes for `yini parse`
 
 The `parse` command supports multiple output styles:
 
@@ -38,7 +96,6 @@ The `parse` command supports multiple output styles:
 |----------------------------------------------------|----------------------|------------------------------------------------------------------------------|
 | `yini parse config.yini`                           | JS-style object       | Uses Node’s `util.inspect` — human-readable, shows types, nesting, etc.     |
 | `yini parse config.yini --pretty`                  | Pretty JSON           | Formatted and indented with `JSON.stringify(obj, null, 4)`.                  |
-| `yini parse config.yini --log`                     | Console log           | Uses `console.log` — quick output but may truncate deep structures.          |
 | `yini parse config.yini --json`                    | Compact JSON          | Compact and machine-friendly `JSON.stringify(obj)`.                          |
 | `yini parse config.yini --output out.txt`          | File (JS-style)       | Default style, written to specified file.                                    |
 | `yini parse config.yini --pretty --output out.json`| File (Pretty JSON)    | Formatted JSON written to file.                                              |
@@ -48,13 +105,26 @@ The `parse` command supports multiple output styles:
 ---
 
 ## Links
-- ➡️ [Why YINI? Why another format!?](https://github.com/YINI-lang/YINI-spec/blob/develop/RATIONALE.md) (rationale)
-- ➡️ [Intro to YINI Config Format](https://github.com/YINI-lang/yini-parser-typescript?tab=readme-ov-file#intro-to-yini-config-format) (learn YINI)
-- ➡️ [Read the YINI Specification](https://github.com/YINI-lang/YINI-spec/blob/develop/YINI-Specification.md#table-of-contents) (spec)
-- ➡️ [Official YINI Parser on npm](https://www.npmjs.com/package/yini-parser) (npm)
-- ➡️ [YINI Parser GitHub Repo](https://github.com/YINI-lang/yini-parser-typescript) (GitHub)
-- ➡️ [YINI vs Other Formats](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Examples%20of%20YINI%20vs%20Other%20Formats.md)
-- ➡️ [YINI Project](https://github.com/YINI-lang) (home)
+- ➡️ [Getting Started: Intro to YINI Config Format](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Intro-to-YINI-Config-Format.md)  
+  *Beginner-friendly walkthrough and basic usage examples.*
+
+- ➡️ [YINI Parser on npm](https://www.npmjs.com/package/yini-parser)  
+  *Install and view package details.*
+
+- ➡️ [Read the YINI Specification](https://github.com/YINI-lang/YINI-spec/blob/release/YINI-Specification.md#table-of-contents)  
+  *Full formal spec for the YINI format, including syntax and features.*
+
+- ➡️ [YINI Parser on GitHub](https://github.com/YINI-lang/yini-parser-typescript)  
+  *TypeScript source code, issue tracker, and contributing guide.*
+
+- ➡️ [YINI vs Other Formats](https://github.com/YINI-lang/YINI-spec/tree/release#-summary-difference-with-other-formats)  
+  *How does YINI differ: comparison with INI, YAML, and JSON.*
+  
+- ➡️ [Why YINI? (Project Rationale)](https://github.com/YINI-lang/YINI-spec/blob/release/RATIONALE.md)  
+  *Learn about the motivations and design decisions behind YINI.*
+
+- ➡️ [YINI Project](https://github.com/YINI-lang)  
+  *YINI home.*
 
 ---
 

package/dist/commands/info.js

@@ -0,0 +1,12 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const pkg = require('../../package.json');
+export const printInfo = () => {
+    console.log(`** YINI CLI **`);
+    console.log(`yini-cli:    ${pkg.version}`);
+    console.log(`yini-parser: ${pkg.dependencies['yini-parser'].replace('^', '')}`);
+    console.log(`Author:      ${pkg.author}`);
+    console.log(`License:     ${pkg.license}`);
+    console.log(`Homepage:    ${pkg.homepage}`);
+    console.log('Repo:        https://github.com/YINI-lang/yini-cli');
+};

package/dist/commands/parse.js

@@ -0,0 +1,71 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import util from 'util';
+import YINI from 'yini-parser';
+import { debugPrint, printObject, toPrettyJSON } from '../utils/print.js';
+export const parseFile = (file, options) => {
+    const outputFile = options.output || '';
+    const isStrictMode = !!options.strict;
+    let outputStyle = 'JS-style';
+    debugPrint('file = ' + file);
+    debugPrint('output = ' + options.output);
+    debugPrint('options:');
+    printObject(options);
+    if (options.pretty) {
+        outputStyle = 'Pretty-JSON';
+    }
+    else if (options.log) {
+        outputStyle = 'Console.log';
+    }
+    else if (options.json) {
+        outputStyle = 'JSON-compact';
+    }
+    else {
+        outputStyle = 'JS-style';
+    }
+    doParseFile(file, outputStyle, isStrictMode, outputFile);
+};
+const doParseFile = (file, outputStyle, isStrictMode = false, outputFile = '') => {
+    // let strictMode = !!options.strict
+    let bailSensitivity = 'auto';
+    let includeMetaData = false;
+    debugPrint('File = ' + file);
+    debugPrint('outputStyle = ' + outputStyle);
+    try {
+        // const raw = fs.readFileSync(file, 'utf-8')
+        // const parsed = YINI.parseFile(
+        //const parsed = YINI.parseFile(file)
+        const parsed = YINI.parseFile(file, isStrictMode, bailSensitivity, includeMetaData);
+        // const parsed = YINI.parse(raw)
+        // const output = options.pretty
+        //     ? // ? JSON.stringify(parsed, null, 2)
+        //       toPrettyJSON(parsed)
+        //     : JSON.stringify(parsed)
+        let output = '';
+        switch (outputStyle) {
+            case 'Pretty-JSON':
+                output = toPrettyJSON(parsed);
+                break;
+            case 'Console.log':
+                output = '<todo>';
+                break;
+            case 'JSON-compact':
+                output = JSON.stringify(parsed);
+                break;
+            default:
+                output = util.inspect(parsed, { depth: null, colors: false });
+        }
+        if (outputFile) {
+            // Write JSON output to file instead of stdout.
+            fs.writeFileSync(path.resolve(outputFile), output, 'utf-8');
+            console.log(`Output written to file: "${outputFile}"`);
+        }
+        else {
+            console.log(output);
+        }
+    }
+    catch (err) {
+        console.error(`Error: ${err.message}`);
+        process.exit(1);
+    }
+};

package/dist/commands/validate.js

@@ -0,0 +1,32 @@
+import fs from 'node:fs';
+import { exit } from 'node:process';
+import YINI from 'yini-parser';
+import { printObject } from '../utils/print.js';
+export const validateFile = (file, options = {}) => {
+    try {
+        const content = fs.readFileSync(file, 'utf-8');
+        const isMeta = true;
+        const parsed = YINI.parse(content, options.strict ?? false, 'auto', isMeta);
+        if (!options.silent) {
+            console.log(`✔  File is valid${options.strict ? ' (strict mode)' : ''}.`);
+            if (options.details) {
+                //@todo format parsed.meta to details as
+                /*
+                 * Details:
+                 * - YINI version: 1.0.0-beta.6
+                 * - Mode: strict
+                 * - Keys: 42
+                 * - Sections: 6
+                 * - Nesting depth: 3
+                 * - Has @yini: true
+                 */
+                printObject(parsed.meta);
+            }
+        }
+        exit(0);
+    }
+    catch (err) {
+        console.error(`✖ Validation failed: ${err.message}`);
+        exit(1);
+    }
+};

package/dist/config/env.js

@@ -0,0 +1,53 @@
+const localNodeEnv = (process.env.NODE_ENV || 'production');
+const localAppEnv = (process.env.APP_ENV || 'production');
+// 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. */
+export const isDevEnv = () => localNodeEnv === 'development';
+/** Are we running in the environment "production"? Will be based on the (global) environment variable process.env.NODE_ENV. */
+export const isProdEnv = () => localNodeEnv === 'production';
+/** Are we running in the environment "test"? Will be based on the (global) variable process.env.NODE_ENV. */
+export const isTestEnv = () => localNodeEnv === 'test';
+/** 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 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;
+};
+/** 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 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;
+};
+export { localNodeEnv, localAppEnv };

package/dist/descriptions.d.ts

@@ -1,6 +1,6 @@
 export declare const descriptions: {
     yini: string;
-    'For-command-info': string;
     'For-command-parse': string;
     'For-command-validate': string;
+    'For-command-info': string;
 };

package/dist/descriptions.js

@@ -0,0 +1,6 @@
+export const descriptions = {
+    yini: 'CLI for parsing and validating YINI config files.',
+    'For-command-parse': 'Parse a YINI file (*.yini) and print the result.',
+    'For-command-validate': 'Checks if the file can be parsed as valid YINI.',
+    'For-command-info': 'Show extended information (details, links, etc.).',
+};