yini-cli 1.0.0-alpha.2

package/tests/general.test.ts

@@ -0,0 +1,86 @@
+/**
+ * General Tests.
+ */
+
+// import pkg from '../package.json'
+import { createRequire } from 'module'
+import fs from 'node:fs'
+import path from 'node:path'
+import { describe, expect, it } from 'vitest'
+import { descriptions as descripts } from '../src/descriptions.js'
+import {
+    debugPrint,
+    printObject,
+    toJSON,
+    toPrettyJSON,
+} from '../src/utils/print.js'
+import { yiniCLI } from './test-helpers.js'
+
+const require = createRequire(import.meta.url)
+const pkg = require('../package.json')
+
+// import pkg from '../package.json' assert { type: 'json' }
+
+const DIR_OF_FIXTURES = 'fixtures/'
+
+describe('Test general yini CLI usage:', () => {
+    const baseDir = path.join(__dirname, DIR_OF_FIXTURES)
+
+    it('1.a) The yini command "--version" correctly outputs version.', async () => {
+        // Arrange.
+        // const fileName = 'valid-config-1.yini'
+        // const fullPath = path.join(baseDir, fileName)
+
+        // Arrange and Act.
+        // Here, execa(..) is used to run CLI script (like tsx src/index.ts myfile.yini),
+        // and to capture stdout, stderr, exitCode, etc.
+        //const { stdout } = await yiniCLI(`parse ${fullPath}`)
+        const { stdout } = await yiniCLI(`--version`)
+        debugPrint('Test: 1:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        //expect(stdout).toContain('{ App:')
+        expect(stdout.trim()).equal(pkg.version)
+    })
+
+    it('1.b) The yini command "-V" (uppecase) correctly outputs version.', async () => {
+        // Arrange and Act.
+        const { stdout } = await yiniCLI(`-V`)
+        debugPrint('Test: 1:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout.trim()).equal(pkg.version)
+    })
+
+    it('2.a) The yini command "--help" correctly outputs help/usage message.', async () => {
+        // Arrange and Act.
+        const { stdout } = await yiniCLI(`--help`)
+        debugPrint('Test: 1:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout).contain(descripts.yini)
+        expect(stdout).contain(descripts['For-command-info'])
+        expect(stdout).contain(descripts['For-command-parse'])
+        expect(stdout).contain(descripts['For-command-validate'])
+    })
+
+    it('2.b) The yini command "-h" correctly outputs help/usage message.', async () => {
+        // Arrange and Act.
+        const { stdout } = await yiniCLI(`-h`)
+        debugPrint('Test: 1:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout).contain(descripts.yini)
+        expect(stdout).contain(descripts['For-command-info'])
+        expect(stdout).contain(descripts['For-command-parse'])
+        expect(stdout).contain(descripts['For-command-validate'])
+    })
+})

package/tests/smoke.test.ts

@@ -0,0 +1,145 @@
+/**
+ * Smoke Tests.
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { describe, expect, it } from 'vitest'
+import {
+    debugPrint,
+    printObject,
+    toJSON,
+    toPrettyJSON,
+} from '../src/utils/print'
+import { yiniCLI } from './test-helpers'
+
+const DIR_OF_FIXTURES = 'fixtures/'
+
+describe('Test yini CLI basic usage:', () => {
+    const baseDir = path.join(__dirname, DIR_OF_FIXTURES)
+
+    it('1. Parses a valid YINI file and print as JS object.', async () => {
+        // Arrange.
+        const fileName = 'valid-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        // Here, execa(..) is used to run CLI script (like tsx src/index.ts myfile.yini),
+        // and to capture stdout, stderr, exitCode, etc.
+        const { stdout } = await yiniCLI(`parse ${fullPath}`)
+        debugPrint('Test: 1:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout).toContain('{ App:')
+        expect(stdout).toContain('title: ')
+        expect(stdout).toContain('My App')
+        expect(stdout).toContain('enabled: true')
+    })
+
+    it('2. Parses nested sections and print as JS object.', async () => {
+        // Arrange.
+        const fileName = 'nested-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        const { stdout } = await yiniCLI(`parse ${fullPath}`)
+        debugPrint('Test: 2:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout).toContain('{ App:')
+        expect(stdout).toContain("name: 'Nested'")
+        expect(stdout).toContain('Database: {')
+        expect(stdout).toContain("host: 'localhost'")
+    })
+
+    it('3. Shows error on invalid YINI that has some garbage.', async () => {
+        // Arrange.
+        const fileName = 'invalid-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        const { stderr, exitCode } = await yiniCLI(`parse ${fullPath}`)
+        debugPrint('Test: 3:')
+        debugPrint('stderr:')
+        printObject(stderr)
+        debugPrint('exitCode:')
+        printObject(exitCode)
+
+        // Assert.
+        expect(exitCode).not.toBe(0)
+        expect(stderr.toLowerCase()).toContain('syntax error')
+    })
+
+    it('4. Parse and print as pretty JSON.', async () => {
+        // Arrange.
+        const fileName = 'nested-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        const { stdout } = await yiniCLI(`parse ${fullPath} --pretty`)
+        debugPrint('Test: 2:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout).toContain('    "App": {')
+        expect(stdout).toContain('        "name": "Nested",')
+        expect(stdout).toContain('        "Database": {')
+        expect(stdout).toContain('            "host": "localhost"')
+    })
+
+    it('5. Parse and print as JSON string.', async () => {
+        // Arrange.
+        const fileName = 'nested-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        const { stdout } = await yiniCLI(`parse ${fullPath} --json`)
+        debugPrint('Test: 2:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        expect(stdout).toContain(
+            '{"App":{"name":"Nested","Database":{"host":"localhost"}}}',
+        )
+    })
+
+    it('6.a. Should pass parsing corrupt YINI in lenient (default) mode.', async () => {
+        // Arrange.
+        const fileName = 'corrupt-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        const { stdout } = await yiniCLI(`parse ${fullPath} --json`)
+        debugPrint('Test: 6.a:')
+        debugPrint('stdout:')
+        printObject(stdout)
+
+        // Assert.
+        const jsObj = { Section: { value: 42 } }
+        expect(stdout).toContain(toJSON(jsObj))
+    })
+
+    it.skip('6.b. Show error on corrupt YINI in strict-mode.', async () => {
+        // Arrange.
+        const fileName = 'corrupt-config-1.yini'
+        const fullPath = path.join(baseDir, fileName)
+
+        // Act.
+        const { stderr, exitCode } = await yiniCLI(`parse ${fullPath} strict`)
+        debugPrint('Test: 6.b:')
+        debugPrint('stderr:')
+        printObject(stderr)
+        debugPrint('exitCode:')
+        printObject(exitCode)
+
+        // Assert.
+        expect(exitCode).not.toBe(0)
+        expect(stderr.toLowerCase()).toContain('syntax error')
+    })
+})

package/tests/test-helpers.ts

@@ -0,0 +1,9 @@
+import { execa } from 'execa'
+
+/**
+ * @param argsLine A line of arguments (command and options) to pass to yini
+ * (yini-cli) on execution in CLI.
+ * @returns
+ */
+export const yiniCLI = (argsLine: string) =>
+    execa('tsx', ['src/index.ts', ...argsLine.split(' ')], { reject: false })

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+  },
+  "include": ["src"]
+}

package/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+    test: {
+        globals: true, // To use "describe", "it", etc. globally.
+        environment: 'node',
+    },
+})