docker-composer 4.1.3 → 5.0.1

package/README.md

@@ -14,8 +14,7 @@ Docker Compose Reference is [HERE](https://docs.docker.com/compose/compose-file/
 
 ###  Changes of the Latest Release
 
-## Version 4.1.3 (22.12.2022)
-- Remove gulp
+## Version 5.0.1 (19.09.2023)
 - Update dependencies
 
 You can find all Release Notes [HERE](https://github.com/tudvari/docker-composer/blob/master/ReleaseNotes.md).
@@ -24,9 +23,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,13 @@
 # Release Notes
 
+## Version 5.0.1 (19.09.2023)
+- Update dependencies
+
+## 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

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,12 +1,13 @@
 {
   "name": "docker-composer",
-  "version": "4.1.3",
-  "description": "NodeJS module for generating docker-compose.yml from a json document.",
+  "version": "5.0.1",
+  "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 compile-ts-types.js"
+    "generate-ts-types": "node ./scripts/compile-ts-types.js",
+    "linter": "npx eslint *.js tests/*.js"
   },
   "keywords": [
     "docker",
@@ -34,9 +35,10 @@
     "jsonschema": "^1.4.0"
   },
   "devDependencies": {
-    "eslint": "8.30.0",
+    "eslint": "^8.30.0",
+    "eslint-config-google": "^0.14.0",
     "js-yaml": "^4.0.0",
-    "json-schema-to-typescript": "^11.0.0",
+    "json-schema-to-typescript": "^13.0.1",
     "mocha": "10.2.0",
     "nyc": "^15.1.0",
     "should": "13.2.3"

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();
+

package/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at tudvari@tudvari.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

package/compile-ts-types.js

@@ -1,10 +0,0 @@
-const fs = require('fs')
-const compiler = require('json-schema-to-typescript')
-
-async function f() {
-  const compiledTs = await compiler.compileFromFile('schema.json');
-  fs.writeFileSync('index.d.ts', compiledTs)
-}
-
-f();
-