refactor: use scalar.config.json instead of scalar.toml

scalar · Feb 9, 2024 · 6a8e8e5 · 6a8e8e5
1 parent c14a559
commit 6a8e8e5
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 15 deletions.
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -80,7 +80,7 @@ If you’re tired of passing the file name again and again, just configure it on
 scalar init
 ```
 
-This will create a `scalar.toml` file for you. All commands will use the configured OpenAPI file by default.
+This will create a `scalar.config.json` file for you. All commands will use the configured OpenAPI file by default.
 
 ## Options
 

diff --git a/packages/cli/src/commands/init/InitCommand.ts b/packages/cli/src/commands/init/InitCommand.ts
@@ -3,20 +3,21 @@ import kleur from 'kleur'
 import fs from 'node:fs'
 import path from 'node:path'
 import prompts from 'prompts'
-import toml from 'toml-js'
+
+import { CONFIG_FILE } from '../../utils'
 
 export function InitCommand() {
   const cmd = new Command('init')
 
-  cmd.description('Create a new `scalar.toml` file')
+  cmd.description('Create a new `scalar.config.json` file')
   cmd.option('-f, --file [file]', 'your OpenAPI file')
   cmd.action(async ({ file }) => {
-    // Path to `scalar.toml` file
-    const configFile = path.resolve('scalar.toml')
+    // Path to `scalar.config.json` file
+    const configFile = path.resolve(CONFIG_FILE)
 
-    // Check if `scalar.toml` already exists
+    // Check if `scalar.config.json` already exists
     if (fs.existsSync(configFile)) {
-      console.warn(kleur.yellow('A `scalar.toml` file already exists.'))
+      console.warn(kleur.yellow(`A ${CONFIG_FILE} file already exists.`))
       console.log()
 
       const { overwrite } = await prompts({
@@ -36,7 +37,7 @@ export function InitCommand() {
 
     // Ask for the OpenAPI file
     const configuration = {
-      reference: { file: '' },
+      references: [],
     }
 
     const { input } = file
@@ -53,12 +54,15 @@ export function InitCommand() {
           },
         })
 
-    configuration.reference.file = input
+    configuration.references.push({
+      name: 'API Reference',
+      path: input,
+    })
 
-    const content = toml.dump(configuration)
+    const content = JSON.stringify(configuration, null, 2)
 
     console.log()
-    console.log(kleur.bold().white('    scalar.toml'))
+    console.log(kleur.bold().white(`    ${CONFIG_FILE}`))
     console.log()
     console.log(
       content
@@ -69,7 +73,7 @@ export function InitCommand() {
     )
     console.log()
 
-    // Create `scalar.toml` file
+    // Create `scalar.config.json` file
     fs.writeFileSync(configFile, content)
 
     console.log(kleur.green('Created a new project configuration.'))

diff --git a/packages/cli/src/commands/init/init.test.ts b/packages/cli/src/commands/init/init.test.ts
@@ -7,7 +7,7 @@ import { ScalarCli } from '../../../tests/invoke-cli'
 describe('init', () => {
   it('creates a config file', () => {
     // Delete config file if it exists
-    const configFile = './scalar.toml'
+    const configFile = './scalar.config.json'
 
     if (fs.existsSync(configFile)) {
       fs.unlinkSync(configFile)
@@ -33,6 +33,14 @@ describe('init', () => {
     expect(fs.readFileSync(configFile, 'utf-8')).toContain(
       './packages/cli/src/commands/validate/valid.json',
     )
+    expect(JSON.parse(fs.readFileSync(configFile, 'utf-8'))).toMatchObject({
+      references: [
+        {
+          name: 'API Reference',
+          path: './packages/cli/src/commands/validate/valid.json',
+        },
+      ],
+    })
     expect(exitCode).toBe(0)
 
     fs.unlinkSync(configFile)

diff --git a/packages/cli/src/utils/useGivenFileOrConfiguration.ts b/packages/cli/src/utils/useGivenFileOrConfiguration.ts
@@ -1,8 +1,9 @@
 import kleur from 'kleur'
-import toml from 'toml-js'
 
 import { readFile } from './'
 
+export const CONFIG_FILE = 'scalar.config.json'
+
 export function useGivenFileOrConfiguration(file?: string) {
   // If a specific file is given, use it.
   if (file) {
@@ -11,7 +12,7 @@ export function useGivenFileOrConfiguration(file?: string) {
 
   // Try to load the configuration
   try {
-    const configuration = toml.parse(readFile('scalar.toml'))
+    const configuration = JSON.parse(readFile(CONFIG_FILE))
 
     if (configuration?.reference?.file) {
       return configuration.reference.file