{"id":24256177,"url":"https://github.com/asmagin/rainbow-js-codegeneration","last_synced_at":"2025-09-23T19:30:38.209Z","repository":{"id":81431875,"uuid":"105102195","full_name":"asmagin/rainbow-js-codegeneration","owner":"asmagin","description":"Code Generation library for Sitecore Rainbow serialization","archived":false,"fork":false,"pushed_at":"2020-06-02T00:16:27.000Z","size":4209,"stargazers_count":3,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-20T21:06:27.931Z","etag":null,"topics":["code-generation","javascript","rainbow","sitecore"],"latest_commit_sha":null,"homepage":"http://asmagin.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asmagin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-28T04:26:22.000Z","updated_at":"2022-04-29T04:41:46.000Z","dependencies_parsed_at":"2023-05-06T02:43:26.068Z","dependency_job_id":null,"html_url":"https://github.com/asmagin/rainbow-js-codegeneration","commit_stats":{"total_commits":23,"total_committers":4,"mean_commits":5.75,"dds":"0.34782608695652173","last_synced_commit":"1e71e37c82edc8408278fe27727af85bef3c2bab"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/asmagin/rainbow-js-codegeneration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmagin%2Frainbow-js-codegeneration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmagin%2Frainbow-js-codegeneration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmagin%2Frainbow-js-codegeneration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmagin%2Frainbow-js-codegeneration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asmagin","download_url":"https://codeload.github.com/asmagin/rainbow-js-codegeneration/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmagin%2Frainbow-js-codegeneration/sbom","scorecard":{"id":212527,"data":{"date":"2025-08-11","repo":{"name":"github.com/asmagin/rainbow-js-codegeneration","commit":"1e71e37c82edc8408278fe27727af85bef3c2bab"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/11 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 24 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"63 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T00:59:58.679Z","repository_id":81431875,"created_at":"2025-08-17T00:59:58.680Z","updated_at":"2025-08-17T00:59:58.680Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276422210,"owners_count":25639630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-22T02:00:08.972Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-generation","javascript","rainbow","sitecore"],"created_at":"2025-01-15T04:57:22.196Z","updated_at":"2025-09-23T19:30:38.201Z","avatar_url":"https://github.com/asmagin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM][package-badge]][package]\n\n[![Build Status][travis-badge]][travis-ci]\n[![Dependencies Status][dependencies-badge]][dependencies]\n\n[![Node.js version][nodejs-badge]][nodejs]\n[![NPM version][npm-badge]][npm]\n\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n[![PRs Welcome][prs-badge]][prs]\n\n# Rainbow JS CodeGeneration\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/asmagin/rainbow-js-codegeneration.svg)](https://greenkeeper.io/)\n\n## Installation\n\n```\nnpm i rainbow-js-codegeneration --saveDev\n```\n\n## API\n---\n\nThe module exposes one method `generate` that accepts `options` object as a parameter\n\n\n``` typescript\nimport { generator, IOptions } from 'rainbow-js-codegeneration';\n//...\nconst options: IOptions = {\n  cwd: path,\n  pattern,\n};\n\nconst result = await generator(options);\n//...\n```\n### generate(options)\nThis method search for files based on pattern provided, read them and construct templates objects. Once processing is done it complies `Handlebars` template and generates C# code.\n\n#### options:\n- **`cwd`**: `string` *(required)* - defines a root directory for a `glob` search;\n- **`pattern`**: `string|string[]` *(required)* - defines a pattern for  the `glob` search;\n- **`templatePath`**: `string` *(default: standard template for `GlassMapper` embedded)* -  path to a `Handlebars` template file that will process templates info.;\n- **`Using`**: `string[]` - a list of `using` that should be rendered in the header of the file;\n- **`ToClass`**: `function(name:string)` *(default: PascalCase class name)* - overrides a logic that generates class names;\n- **`ToInterface`**: `function(name:string)` *(default: class name prepended with 'I')*- overrides a logic that generates interface names;\n- **`ToNamespace`**: `function(path:string)` *(default: section of a path excluding `/sitecore/templates` and template name)* - overrides a logic that generates namespace names;\n- **`ToProperty`**: `function(name:string)` *(default: PascalCase property name)*- overrides a logic that generates property names from field names;\n- **`ToPropertyType`**: `function(type:string, id:string)` *(default: simple mapping to available types in GlassMapper)* - extends logic related to mapping of a fields to C# tpe of a property. If return `undefined` will fall back to default.\n\n#### context\nThe method will compile provided or embedded template and pass two objects there `templates` and `options`\n\nSample of a template file:\n``` handlebars\n#pragma warning disable 1591\n#pragma warning disable 0108\n//------------------------------------------------------------------------------\n// \u003cauto-generated\u003e\n//     This code was generated by Rainbow JS CodeGeneration.\n//     (https://github.com/asmagin/rainbow-js-codegeneration)\n//\n//     Changes to this file may cause incorrect behavior and will be lost if\n//     the code is regenerated.\n// \u003c/auto-generated\u003e\n//------------------------------------------------------------------------------\n\nusing System;\nusing System.Collections.Generic;\nusing System.Collections.Specialized;\nusing System.Linq;\nusing System.Text;\nusing Glass.Mapper.Sc.Configuration.Attributes;\nusing Glass.Mapper.Sc.Configuration;\nusing Glass.Mapper.Sc.Fields;\nusing Sitecore.Globalization;\nusing Sitecore.Data;\nusing Sitecore.Data.Items;\n\n{{#each options.Using}}using {{this}};\\n{{/each}}\n{{#each templates}}\n\nnamespace {{this.AsNamespace}}\n{\n\n  /// \u003csummary\u003e\n  /// {{this.AsInterface}} Interface\n  /// \u003cpara\u003ePath: {{this.Path}}\u003c/para\u003e\n  /// \u003cpara\u003eID: {{this.ID}}\u003c/para\u003e\n  /// \u003c/summary\u003e\n  [SitecoreType(TemplateId=\"{{this.ID}}\")]\n  public partial interface {{this.AsInterface}}: {{#each this.BaseTemplates}}{{this.AsInterface}}, {{/each}}IGlassBase\n  {\n    {{#each this.Fields}}\n\n    /// \u003csummary\u003e\n    /// The {{this.PropertyName}} field.\n    /// \u003cpara\u003eField Type: {{this.Type}}\u003c/para\u003e\n    /// \u003cpara\u003eField ID: {{this.ID}}\u003c/para\u003e\n    /// \u003c/summary\u003e\n    [SitecoreField(\"{{this.Name}}\")]\n    {{{this.AsPropertyType}}} {{this.AsProperty}} {get; set;}\n    {{/each}}\n\n  }\n}\n{{/each}}\n```\n\n### Template Helpers\n`guid-b`: will convert text to UPPER CASE and wrap in `{` `}`. Could be used to emulate output of `C#` method `.ToString(\"B\")`\n``` handlebars\n{{guid-b this.ID}}\n{{! will return \"{00000000-ABCD-0000-0000-000000000000}\"}}\n```\n`guid-d`: will convert text to UPPER CASE. Could be used to emulate output of `C#` method `.ToString(\"D\")`\n``` handlebars\n{{guid-b this.ID}}\n{{! will return \"00000000-ABCD-0000-0000-000000000000\"}}\n```\n\n## Gulp integration\n### generationPlugin()\nThe library provides a Gulp plugin. The plugin will generate code file for each `configuration` file detected. See example below:\n\n``` js\n// other imports\nvar codeGen = require('rainbow-js-codegeneration').generationPlugin;\n\n// code generation task\ngulp.task(\"Generate-Code\", function (callback) {\n  gulp.src('**/codegeneration.config.js', { base: \"./\" })\n    .pipe(codeGen())\n    .pipe(rename(function (path) {\n      path.basename = \"Templates.Generated\";\n      path.extname = \".cs\"\n    }))\n    .pipe(gulp.dest('./'))\n    .on(\"end\", function () { // will make sure that you wait for generation to finish\n      callback();\n    });\n});\n```\n\n### Configuration\nConfiguration of the library could be provided via JS module. See example below:\n``` js\nvar path = require(\"path\");\n\nmodule.exports = {\n  cwd: path.join(__dirname, '..'),\n  pattern: '**/serialization/*.Templates/**/*.yml',\n  Using: [ 'System.CodeDom.Compiler' ],\n  templatePath: path.join(__dirname, 'codegeneration.tmpl'),\n}\n```\n\n## Available scripts\n\n+ `clean` - remove coverage data, Jest cache and transpiled files,\n+ `build` - transpile TypeScript to ES6,\n+ `watch` - interactive watch mode to automatically transpile source files,\n+ `lint` - lint source files and tests,\n+ `test` - run tests,\n+ `test:watch` - interactive watch mode to automatically re-run tests\n\n## License\nLicensed under the MIT. See the [LICENSE](https://github.com/asmagin/rainbow-js-codegeneration/blob/master/LICENSE) file for details.\n\n[package-badge]: https://nodei.co/npm/rainbow-js-codegeneration.png?downloads=true\u0026downloadRank=true\u0026stars=true\n[package]: https://npmjs.org/package/rainbow-js-codegeneration\n\n[dependencies-badge]: https://david-dm.org/asmagin/rainbow-js-codegeneration/dev-status.svg\n[dependencies]: https://david-dm.org/asmagin/rainbow-js-codegeneration\n\n[nodejs-badge]: https://img.shields.io/badge/node-\u003e=%206.9.0-blue.svg\n[nodejs]: https://nodejs.org/dist/latest-v6.x/docs/api/\n\n[npm-badge]: https://img.shields.io/badge/npm-\u003e=%203.10.8-blue.svg\n[npm]: https://docs.npmjs.com/\n\n[travis-badge]: https://travis-ci.org/asmagin/rainbow-js-codegeneration.svg?branch=master\n[travis-ci]: https://travis-ci.org/asmagin/rainbow-js-codegeneration\n\n[license]: https://github.com/asmagin/rainbow-js-codegeneration/blob/master/LICENSE\n\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[prs]: http://makeapullrequest.com\n\n[github-watch-badge]: https://img.shields.io/github/watchers/asmagin/rainbow-js-codegeneration.svg?style=social\n[github-watch]: https://github.com/asmagin/rainbow-js-codegeneration/watchers\n\n[github-star-badge]: https://img.shields.io/github/stars/asmagin/rainbow-js-codegeneration.svg?style=social\n[github-star]: https://github.com/asmagin/rainbow-js-codegeneration/stargazers","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmagin%2Frainbow-js-codegeneration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasmagin%2Frainbow-js-codegeneration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmagin%2Frainbow-js-codegeneration/lists"}