Merge pull request #8 from rawand-faraidun/dev

config file schema

.changeset/spotty-lies-thank.md

@@ -0,0 +1,5 @@
+---
+'linguify': patch
+---
+
+Configuration file schema

assets/schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "localesPath": {
+      "type": "string",
+      "description": "Path to application locales folder",
+      "default": "./public/locales",
+      "$comment": "Path to application locales folder"
+    },
+    "locales": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Supported locales by your applications",
+      "default": ["en"],
+      "$comment": "Supported locales by your applications"
+    },
+    "defaultLocale": {
+      "type": "string",
+      "description": "default locale to your application",
+      "default": "en",
+      "$comment": "default locale to your application"
+    }
+  },
+  "required": ["localesPath", "locales", "defaultLocale"]
+}

lib/defaults.ts

@@ -5,10 +5,16 @@ import type { Config } from './types'
  */
 export const configFileName = 'linguify.config.json'
 
+/**
+ * config schema path
+ */
+export const configSchemaPath = 'https://github.com/rawand-faraidun/linguify/blob/main/assets/schema.json'
+
 /**
  * linguify default values
  */
-export const defaultConfig: Config = {
+export const defaultConfig = {
+  $schema: configSchemaPath,
   localesPath: './public/locales',
   locales: ['en'],
   defaultLocale: 'en'

lib/utils.ts

@@ -2,6 +2,7 @@ import { resolve } from 'path'
 import findup from 'findup-sync'
 import { configFileName, defaultConfig } from './defaults'
 import { getUserConfig } from './functions'
+import type { Config } from './types'
 
 /**
  * `node_modules` path, used to detect root
@@ -42,7 +43,7 @@ export const configPath = configPathExpected || configPathRoot
 /**
  * configuration
  */
-export const config = { ...defaultConfig, ...getUserConfig() }
+export const config: Config = { ...defaultConfig, ...getUserConfig() }
 
 /**
  * other languages from config