docker-composer 4.1.2 → 5.0.0

package/.eslintrc.yml

@@ -0,0 +1,9 @@
+env:
+  browser: true
+  es2021: true
+extends: google
+overrides: []
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+rules: {}

package/README.md

@@ -14,8 +14,10 @@ Docker Compose Reference is [HERE](https://docs.docker.com/compose/compose-file/
 
 ###  Changes of the Latest Release
 
-## Version 4.1.2 (05.11.2022)
-- Maintenance release, dependency updates
+## Version 5.0.0 (29.12.2022)
+- Reorganize code base
+- Update dependencies
+- Change code style
 
 You can find all Release Notes [HERE](https://github.com/tudvari/docker-composer/blob/master/ReleaseNotes.md).
 
@@ -23,9 +25,9 @@ You can find all Release Notes [HERE](https://github.com/tudvari/docker-composer
 
 ```javascript
 
-  const composer = require('docker-composer')
+  const composer = require('docker-composer');
     .
-  var generatedYML = composer.generate( inputJSON )
+  const generatedYML = composer.generate(inputJSON);
 ```
 
 ## Full Example

package/ReleaseNotes.md

@@ -1,5 +1,14 @@
 # Release Notes
 
+## Version 5.0.0 (29.12.2022)
+- Reorganize code base
+- Update dependencies
+- Change code style
+
+## Version 4.1.3 (22.12.2022)
+- Remove gulp
+- Update dependencies
+
 ## Version 4.1.2 (05.11.2022)
 - Maintenance release, dependency updates
 

package/index.d.ts

@@ -1,3 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
 export type DefinitionsDeployment = {
   mode?: string;
   replicas?: number;
@@ -22,7 +29,17 @@ export type DefinitionsDeployment = {
   placement?: {
     constraints?: string[];
   };
-} & ({
+} & Deployment;
+export type Labels =
+  | {
+      /**
+       * This interface was referenced by `undefined`'s JSON-Schema definition
+       * via the `patternProperty` ".+".
+       */
+      [k: string]: string;
+    }
+  | string[];
+export type Deployment = {
   mode?: string;
   replicas?: number;
   labels?: Labels;
@@ -46,16 +63,7 @@ export type DefinitionsDeployment = {
   placement?: {
     constraints?: string[];
   };
-} | null);
-export type Labels =
-  | {
-      /**
-       * This interface was referenced by `undefined`'s JSON-Schema definition
-       * via the `patternProperty` ".+".
-       */
-      [k: string]: string;
-    }
-  | string[];
+} | null;
 export type ListOrDict =
   | {
       /**
@@ -73,6 +81,7 @@ export type StringOrList = string | ListOfStrings;
  */
 export type DefinitionsNetwork = {
   driver?: string;
+  name?: string;
   driver_opts?: {
     /**
      * This interface was referenced by `undefined`'s JSON-Schema definition
@@ -93,8 +102,10 @@ export type DefinitionsNetwork = {
       };
   internal?: boolean;
   labels?: Labels;
-} & ({
+} & Network;
+export type Network = {
   driver?: string;
+  name?: string;
   driver_opts?: {
     /**
      * This interface was referenced by `undefined`'s JSON-Schema definition
@@ -115,7 +126,7 @@ export type DefinitionsNetwork = {
       };
   internal?: boolean;
   labels?: Labels;
-} | null);
+} | null;
 /**
  * This interface was referenced by `PropertiesVolumes`'s JSON-Schema definition
  * via the `patternProperty` "^[a-zA-Z0-9._-]+$".
@@ -135,7 +146,8 @@ export type DefinitionsVolume = {
         name?: string;
       };
   labels?: Labels;
-} & ({
+} & Volume;
+export type Volume = {
   driver?: string;
   driver_opts?: {
     /**
@@ -150,7 +162,7 @@ export type DefinitionsVolume = {
         name?: string;
       };
   labels?: Labels;
-} | null);
+} | null;
 
 export interface ConfigSchemaV30Json {
   version: string;

package/index.js

@@ -1,18 +1,14 @@
-const fs = require('fs')
-const path = require('path')
-const YAML = require('json2yaml')
-const Validator = require('jsonschema').Validator
-const v = new Validator()
-
-function generateCompose ( inputJSON ) {
-	let schema = JSON.parse(fs.readFileSync(path.resolve(__dirname, './schema.json')))
-
-	if ( !v.validate(inputJSON, schema).valid )
-		throw new Error('Invalid input!')
-
-	return YAML.stringify( inputJSON )
+const lib = require('./lib/lib.js');
+
+/**
+ * Generate compose file from a JSON document
+ * @param {string} inputJSON - JSON document, what represent the compose file.
+ * @return {string} The generated compose file in YAML format.
+ */
+function generateCompose(inputJSON) {
+  return lib.generateCompose(inputJSON);
 }
 
 module.exports = {
-	generate: generateCompose
-}
+  generate: generateCompose,
+};

package/lib/lib.js

@@ -0,0 +1,24 @@
+const fs = require('fs');
+const path = require('path');
+const YAML = require('json2yaml');
+const Validator = require('jsonschema').Validator;
+const v = new Validator();
+
+/**
+ * Generate compose file from a JSON document
+ * @param {string} inputJSON - JSON document, what represent the compose file.
+ * @return {string} The generated compose file in YAML format.
+ */
+function generateCompose(inputJSON) {
+  const schema = JSON.parse(
+      fs.readFileSync(path.resolve(__dirname, '../schema.json')));
+
+  if (!v.validate(inputJSON, schema).valid) {
+    throw new Error('Invalid input!');
+  }
+  return YAML.stringify(inputJSON);
+}
+
+module.exports = {
+  generateCompose,
+};

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "docker-composer",
-  "version": "4.1.2",
-  "description": "NodeJS module for generating docker-compose.yml from a json document.",
+  "version": "5.0.0",
+  "description": "Library for generating docker-compose.yml from JSON.",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha.js *Test.js",
+    "test": "./node_modules/mocha/bin/mocha.js ./tests/*Test.js",
     "coverage": "nyc npm run test",
-    "generate-ts-types": "./node_modules/gulp-cli/bin/gulp.js"
+    "generate-ts-types": "node ./scripts/compile-ts-types.js",
+    "linter": "npx eslint *.js tests/*.js"
   },
   "keywords": [
-    "gulp",
     "docker",
     "compose",
     "docker-compose.yml"
@@ -35,19 +35,12 @@
     "jsonschema": "^1.4.0"
   },
   "devDependencies": {
-    "ansi-regex": "^6.0.1",
-    "atob": ">=2.1.2",
-    "copy-props": "^4.0.0",
-    "eslint": "8.26.0",
-    "glob-parent": "6.0.2",
-    "gulp": "^4.0.2",
-    "gulp-cli": "^2.3.0",
+    "eslint": "^8.30.0",
+    "eslint-config-google": "^0.14.0",
     "js-yaml": "^4.0.0",
     "json-schema-to-typescript": "^11.0.0",
-    "mixin-deep": ">=2.0.1",
-    "mocha": "10.1.0",
+    "mocha": "10.2.0",
     "nyc": "^15.1.0",
-    "set-value": "^4.0.1",
     "should": "13.2.3"
   },
   "nyc": {

package/scripts/compile-ts-types.js

@@ -0,0 +1,16 @@
+const fs = require('fs');
+const path = require('path');
+const compiler = require('json-schema-to-typescript');
+
+/**
+ * Helper function to generate typescript types from json schema
+ */
+async function runner() {
+  const compiledTs = await compiler.compileFromFile(
+      path.resolve(__dirname, '../schema.json'));
+  fs.writeFileSync('index.d.ts', compiledTs);
+  console.log('Types are generated..');
+}
+
+runner();
+