From c49ff00c31564be8d3e71c500498b11e4707069c Mon Sep 17 00:00:00 2001 From: sharevb Date: Wed, 3 Apr 2024 22:38:34 +0200 Subject: [PATCH] feat(new tool): Docker Compose Validator New tool to validate docker-compose.yml files against Docker Compose Specification Fix part of #540 --- package.json | 1 + pnpm-lock.yaml | 48 ++++++++++--- .../composeverter.d.ts | 19 +++++ .../docker-compose-validator.vue | 70 +++++++++++++++++++ src/tools/docker-compose-validator/index.ts | 12 ++++ src/tools/index.ts | 2 + 6 files changed, 141 insertions(+), 11 deletions(-) create mode 100644 src/tools/docker-compose-validator/composeverter.d.ts create mode 100644 src/tools/docker-compose-validator/docker-compose-validator.vue create mode 100644 src/tools/docker-compose-validator/index.ts diff --git a/package.json b/package.json index fd6c02e6..8fe222d2 100644 --- a/package.json +++ b/package.json @@ -51,6 +51,7 @@ "change-case": "^4.1.2", "colord": "^2.9.3", "composerize-ts": "^0.6.2", + "composeverter": "^1.7.2", "country-code-lookup": "^0.1.0", "cron-validator": "^1.3.1", "cronstrue": "^2.26.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index bd6c38c9..e8f30939 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -53,6 +53,9 @@ dependencies: composerize-ts: specifier: ^0.6.2 version: 0.6.2 + composeverter: + specifier: ^1.7.2 + version: 1.7.2 country-code-lookup: specifier: ^0.1.0 version: 0.1.0 @@ -3351,7 +3354,7 @@ packages: dependencies: '@unhead/dom': 0.5.1 '@unhead/schema': 0.5.1 - '@vueuse/shared': 10.7.2(vue@3.3.4) + '@vueuse/shared': 10.9.0(vue@3.3.4) unhead: 0.5.1 vue: 3.3.4 transitivePeerDependencies: @@ -3993,10 +3996,10 @@ packages: - vue dev: false - /@vueuse/shared@10.7.2(vue@3.3.4): - resolution: {integrity: sha512-qFbXoxS44pi2FkgFjPvF4h7c9oMDutpyBdcJdMYIMg9XyXli2meFMuaKn+UMgsClo//Th6+beeCgqweT/79BVA==} + /@vueuse/shared@10.9.0(vue@3.3.4): + resolution: {integrity: sha512-Uud2IWncmAfJvRaFYzv5OHDli+FbOzxiVEQdLCKQKLyhz94PIyFC3CHcH7EDMwIn8NPtD06+PNbC/PiO0LGLtw==} dependencies: - vue-demi: 0.14.6(vue@3.3.4) + vue-demi: 0.14.7(vue@3.3.4) transitivePeerDependencies: - '@vue/composition-api' - vue @@ -4051,6 +4054,14 @@ packages: - supports-color dev: true + /ajv-errors@3.0.0(ajv@8.12.0): + resolution: {integrity: sha512-V3wD15YHfHz6y0KdhYFjyy9vWtEVALT9UrxfN3zqlI6dMioHnJrqOYfyPKol3oqrnCM9uwkcdCwkJ0WUcbLMTQ==} + peerDependencies: + ajv: ^8.0.1 + dependencies: + ajv: 8.12.0 + dev: false + /ajv@6.12.6: resolution: {integrity: sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==} dependencies: @@ -4067,7 +4078,6 @@ packages: json-schema-traverse: 1.0.0 require-from-string: 2.0.2 uri-js: 4.4.1 - dev: true /ansi-colors@4.1.3: resolution: {integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==} @@ -4560,6 +4570,15 @@ packages: yamljs: 0.3.0 dev: false + /composeverter@1.7.2: + resolution: {integrity: sha512-gRSCkSU8wJQvmTHQ23wBd2gCdUsns95k3lL7YszZBu5EyA3eac46mI7nVgvk1pZTM0mOmj/E5yurtdYkuVNZRA==} + dependencies: + ajv: 8.12.0 + ajv-errors: 3.0.0(ajv@8.12.0) + core-js: 2.6.12 + yaml: 1.10.2 + dev: false + /concat-map@0.0.1: resolution: {integrity: sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=} @@ -4613,6 +4632,12 @@ packages: browserslist: 4.22.1 dev: true + /core-js@2.6.12: + resolution: {integrity: sha512-Kb2wC0fvsWfQrgk8HU5lW6U/Lcs8+9aaYcy4ZFc6DDlo4nZ7n70dEgE5rtR0oG6ufKDUnrwfWL1mXR5ljDatrQ==} + deprecated: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js. + requiresBuild: true + dev: false + /country-code-lookup@0.1.0: resolution: {integrity: sha512-IOI66HEG+8bXfWPy+sTzuN7161vmDZOHg1wgIPFf3WfD73FeLajnn6C+fnxOIa9RL1WRBDMXQQWW/FOaOYaQ3w==} dev: false @@ -6571,7 +6596,6 @@ packages: /json-schema-traverse@1.0.0: resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} - dev: true /json-schema@0.4.0: resolution: {integrity: sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==} @@ -7666,7 +7690,6 @@ packages: /punycode@2.3.0: resolution: {integrity: sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==} engines: {node: '>=6'} - dev: true /punycode@2.3.1: resolution: {integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==} @@ -7814,7 +7837,6 @@ packages: /require-from-string@2.0.2: resolution: {integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==} engines: {node: '>=0.10.0'} - dev: true /require-main-filename@2.0.0: resolution: {integrity: sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==} @@ -8913,7 +8935,6 @@ packages: resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} dependencies: punycode: 2.3.0 - dev: true /url-parse@1.5.10: resolution: {integrity: sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ==} @@ -9151,8 +9172,8 @@ packages: vue: 3.3.4 dev: false - /vue-demi@0.14.6(vue@3.3.4): - resolution: {integrity: sha512-8QA7wrYSHKaYgUxDA5ZC24w+eHm3sYCbp0EzcDwKqN3p6HqtTCGR/GVsPyZW92unff4UlcSh++lmqDWN3ZIq4w==} + /vue-demi@0.14.7(vue@3.3.4): + resolution: {integrity: sha512-EOG8KXDQNwkJILkx/gPcoL/7vH+hORoBaKgGe+6W7VFMvCYJfmF2dGbvgDroVnI8LU7/kTu8mbjRZGBU1z9NTA==} engines: {node: '>=12'} hasBin: true requiresBuild: true @@ -9579,6 +9600,11 @@ packages: yaml: 2.2.1 dev: true + /yaml@1.10.2: + resolution: {integrity: sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==} + engines: {node: '>= 6'} + dev: false + /yaml@2.2.1: resolution: {integrity: sha512-e0WHiYql7+9wr4cWMx3TVQrNwejKaEe7/rHNmQmqRjazfOP5W8PB6Jpebb5o6fIapbz9o9+2ipcaTM2ZwDI6lw==} engines: {node: '>= 14'} diff --git a/src/tools/docker-compose-validator/composeverter.d.ts b/src/tools/docker-compose-validator/composeverter.d.ts new file mode 100644 index 00000000..e2f06ab5 --- /dev/null +++ b/src/tools/docker-compose-validator/composeverter.d.ts @@ -0,0 +1,19 @@ +declare module 'composeverter' { + interface Configuration { + expandVolumes?: boolean; + expandPorts?: boolean; + indent?: number; + } + interface DockerComposeValidatioError { + line?: number; + message: string; + helpLink?: string; + } + export function validateDockerComposeToCommonSpec(content: string): DockerComposeValidatioError[]; + export function migrateFromV2xToV3x(content: string, configuration?: Configuration = null): string; + export function migrateFromV3xToV2x(content: string, configuration?: Configuration = null): string; + export function migrateFromV1ToV2x(content: string, configuration?: Configuration = null): string; + export function migrateToCommonSpec(content: string, configuration?: Configuration = null): string; + export function migrateFromV2xToV3x(content: string, configuration?: Configuration = null): string; + export function getDockerComposeSchemaWithoutFormats(): object; + } \ No newline at end of file diff --git a/src/tools/docker-compose-validator/docker-compose-validator.vue b/src/tools/docker-compose-validator/docker-compose-validator.vue new file mode 100644 index 00000000..ba02ecb4 --- /dev/null +++ b/src/tools/docker-compose-validator/docker-compose-validator.vue @@ -0,0 +1,70 @@ + + + diff --git a/src/tools/docker-compose-validator/index.ts b/src/tools/docker-compose-validator/index.ts new file mode 100644 index 00000000..60e0a88d --- /dev/null +++ b/src/tools/docker-compose-validator/index.ts @@ -0,0 +1,12 @@ +import { BrandDocker } from '@vicons/tabler'; +import { defineTool } from '../tool'; + +export const tool = defineTool({ + name: 'Docker Compose Validator', + path: '/docker-compose-validator', + description: 'Validate Docker Compose files against CommonSpec schema', + keywords: ['docker', 'compose', 'validator', 'commonspec'], + component: () => import('./docker-compose-validator.vue'), + icon: BrandDocker, + createdAt: new Date('2024-01-25'), +}); diff --git a/src/tools/index.ts b/src/tools/index.ts index aa861c93..a6d82892 100644 --- a/src/tools/index.ts +++ b/src/tools/index.ts @@ -6,6 +6,7 @@ import { tool as asciiTextDrawer } from './ascii-text-drawer'; import { tool as textToUnicode } from './text-to-unicode'; import { tool as safelinkDecoder } from './safelink-decoder'; +import { tool as dockerComposeValidator } from './docker-compose-validator'; import { tool as pdfSignatureChecker } from './pdf-signature-checker'; import { tool as numeronymGenerator } from './numeronym-generator'; import { tool as macAddressGenerator } from './mac-address-generator'; @@ -146,6 +147,7 @@ export const toolsByCategory: ToolCategory[] = [ sqlPrettify, chmodCalculator, dockerRunToDockerComposeConverter, + dockerComposeValidator, xmlFormatter, yamlViewer, ],