@mintlify/validation 0.1.46 → 0.1.47

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Mintlify, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Mintlify, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,55 +1,55 @@
-# @mintlify/validation
-
-`@mintlify/validation` is a small package to validate `mint.json` files.
-
-# Installation
-
-```
-npm install @mintlify/validation
-```
-
-# Usage
-
-```
-import mintValidation from "@mintlify/validation"
-
-const configObject = { name: "Site Name", navigation: [] }
-
-mintValidation.validateMintConfig(configObject)
-```
-
-This package assumes you have already loaded a config object into a JavaScript object.
-
-## Return Values
-
-The package returns an object with the properties `status`, `warnings`, and `errors`.
-
-`status` can be one of: `"success"`, `"error"`.
-
-`warnings` is a string array with warnings the user should know but are not expected to break the site.
-
-`errors` is a string array of errors that will likely break the site.
-
-When `status === "error"` you should stop trying to build `mint`, your `mint.json` file is invalid and the site will crash when building.
-
-## Return Value Example
-
-```
-{
-    "status": "error",
-    "warnings": ["Navigation is an empty array, no pages will be shown"],
-    "errors": ["Mintlify does not support .ico favicons, use .svg or .png instead."]
-}
-```
-
-## Documentation
-
-Additional documentation on `mint.json` is available on [Mintlify's website](https://mintlify.com/docs/settings/global).
-
-# Community
-
-Join our Discord community if you have questions or just want to chat:
-
-[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)
-
-_Built with 💚 by the Mintlify community._
+# @mintlify/validation
+
+`@mintlify/validation` is a small package to validate `mint.json` files.
+
+# Installation
+
+```
+npm install @mintlify/validation
+```
+
+# Usage
+
+```
+import mintValidation from "@mintlify/validation"
+
+const configObject = { name: "Site Name", navigation: [] }
+
+mintValidation.validateMintConfig(configObject)
+```
+
+This package assumes you have already loaded a config object into a JavaScript object.
+
+## Return Values
+
+The package returns an object with the properties `status`, `warnings`, and `errors`.
+
+`status` can be one of: `"success"`, `"error"`.
+
+`warnings` is a string array with warnings the user should know but are not expected to break the site.
+
+`errors` is a string array of errors that will likely break the site.
+
+When `status === "error"` you should stop trying to build `mint`, your `mint.json` file is invalid and the site will crash when building.
+
+## Return Value Example
+
+```
+{
+    "status": "error",
+    "warnings": ["Navigation is an empty array, no pages will be shown"],
+    "errors": ["Mintlify does not support .ico favicons, use .svg or .png instead."]
+}
+```
+
+## Documentation
+
+Additional documentation on `mint.json` is available on [Mintlify's website](https://mintlify.com/docs/settings/global).
+
+# Community
+
+Join our Discord community if you have questions or just want to chat:
+
+[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)
+
+_Built with 💚 by the Mintlify community._

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { MintValidationResults } from './mint-config/common';
-import type { ConfigType } from './mint-config/types';
-export declare function validateMintConfig(config: ConfigType): MintValidationResults;
-export * from './openapi/types/endpoint';
-export * from './mint-config/types';
-export { convertOpenAPIV3_1ToEndpoint } from './openapi/convertOpenApi';
-export declare const mintConfigSchema: any;
+import { MintValidationResults } from './mint-config/common';
+import type { ConfigType } from './mint-config/types';
+export declare function validateMintConfig(config: ConfigType): MintValidationResults;
+export * from './openapi/types/endpoint';
+export * from './mint-config/types';
+export { convertOpenAPIV3_1ToEndpoint } from './openapi/convertOpenApi';
+export declare const mintConfigSchema: any;