{"id":17214617,"url":"https://github.com/frontainer/frontnote","last_synced_at":"2025-10-25T17:14:55.783Z","repository":{"id":19700693,"uuid":"22955646","full_name":"frontainer/frontnote","owner":"frontainer","description":"Node.jsを使ったスタイルガイドジェネレーター","archived":false,"fork":false,"pushed_at":"2018-05-30T05:06:03.000Z","size":700,"stargazers_count":69,"open_issues_count":0,"forks_count":6,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-10-09T01:02:52.367Z","etag":null,"topics":["css","frontnote","sass","scss","styleguide","stylus"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/frontainer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-14T13:56:29.000Z","updated_at":"2025-06-27T19:32:05.000Z","dependencies_parsed_at":"2022-08-05T05:00:27.828Z","dependency_job_id":null,"html_url":"https://github.com/frontainer/frontnote","commit_stats":null,"previous_names":["frontainer/frontnote","sable-virt/frontnote"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/frontainer/frontnote","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontainer%2Ffrontnote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontainer%2Ffrontnote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontainer%2Ffrontnote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontainer%2Ffrontnote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frontainer","download_url":"https://codeload.github.com/frontainer/frontnote/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontainer%2Ffrontnote/sbom","scorecard":{"id":412068,"data":{"date":"2025-08-11","repo":{"name":"github.com/frontainer/frontnote","commit":"c272b9f689daeaf98666c891c5aebef80b5c6b17"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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 1/28 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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"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":"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":"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 3 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"}}]},"last_synced_at":"2025-08-18T22:58:13.032Z","repository_id":19700693,"created_at":"2025-08-18T22:58:13.032Z","updated_at":"2025-08-18T22:58:13.032Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280988263,"owners_count":26425486,"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-10-25T02:00:06.499Z","response_time":81,"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":["css","frontnote","sass","scss","styleguide","stylus"],"created_at":"2024-10-15T03:04:52.782Z","updated_at":"2025-10-25T17:14:55.755Z","avatar_url":"https://github.com/frontainer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FrontNote\n[![GitHub version](https://badge.fury.io/gh/frontainer%2Ffrontnote.svg)](http://badge.fury.io/gh/frontainer%2Ffrontnote)\n[![Build Status](https://travis-ci.org/frontainer/frontnote.svg)](https://travis-ci.org/frontainer/frontnote)\n[![Code Climate](https://codeclimate.com/github/frontainer/frontnote/badges/gpa.svg)](https://codeclimate.com/github/frontainer/frontnote)\n\n![FrontNote](http://frontainer.com/images/frontnote.png)\n\nStyleGuide Generator\nNode.jsを使ったスタイルガイドジェネレーター\n\n## Usage - 使い方\n\nFirst, install `frontnote`:\n\n```shell\nnpm install frontnote --save-dev\n```\n\n```js\nvar FrontNote = require('frontnote');\nvar note = new FrontNote({\n\tout: './docs'\n});\nnote.render('path/**/*.css').subscribe(function() {\n\t//callback\n});\n```\n\n## Plugins - プラグイン\n\n* Grunt - [grunt-frontnote](https://www.npmjs.org/package/grunt-frontnote)\n* Gulp - [gulp-frontnote](https://www.npmjs.org/package/gulp-frontnote)\n\n## API\n\n### FrontNote(options);\n\n#### options\nType: `Object`\nDefault value: `{}`\n\nOption.\nPlease see options section for more information.\n\nオプション\n詳しくはオプションの項をご覧ください。\n\n### note.render(files,callback);\n\n#### files\n@Required  \nType: `String | Array`  \nPattern to be matched.  \nPlease see the [minimatch](https://github.com/isaacs/minimatch) documentation for more details.\n\nマッチさせたいパターン  \n詳しくは[minimatch](https://github.com/isaacs/minimatch)のドキュメントをご覧ください。\n\n#### callback\nType: `Function`\nDefault value: `null`\n\nCall this function when generated style guide.\n\nスタイルガイドが生成された後に実行するされる関数\n\n## Option - オプション\n\n### options.title\nType: `String`\nDefault value: `StyleGuide`\n\nTitle of StyleGuide.\n\nスタイルガイドのタイトル\n\nログを詳細に表示します\n\n### options.overview\nType: `String`\nDefault value: `__dirname + '/styleguide.md''`\n\nStyleGuide overview file's path.\nOverview file is required Markdown format.  \n\nindex.htmlに表示するオーバービューファイル(マークダウン)のパス  \nオーバービューファイルはマークダウン形式です。\n\n### options.template\nType: `String`\nDefault value: `__dirname + '/template''`\n\nStyleGuide template path.  \n\nスタイルガイドのテンプレートパス\n\n### options.includeAssetPath\nType: `String`\nDefault value: `assets/**/*`\n\nThe path of the file you want to copy the generated directory.\n\n生成されたディレクトリにコピーしたいファイルパス\n\n### options.out\nType: `String`\nDefault value: `./frontnote`\n\nDirectory in which to generate a style guide.\n\n### options.css\nType: `String|Array`\nDefault value: `./style.css`\n\nPath of CSS that you want to read in HTML. In the array or string.\n\nHTMLに読み込みたいCSSのパス。文字列または配列で指定します。\n\n### options.script\nType: `String|Array`\nDefault value: `null`\n\nPath of JS that you want to read in HTML. In the array or string.\n\nHTMLに読み込みたいJSのパス。文字列または配列で指定します。\n\n### options.clean\nType: `Boolean`\nDefault value: `false`\n\nClean files and folder from options.out directory.\n\n出力先ディレクトリとファイルを削除します。\n\n### options.verbose\nType: `Boolean`\nDefault value: `false`\n\nDisplay a detailed log\n\nログを詳細に表示します\n\n### options.params\nType: `Object`\nDefault value: `{}`\n\nCustom variables for using ejs templates.\n\nejsテンプレート内で使う任意の変数を定義できます。\n\n## Template - テンプレート\n\n[frontnote-template](https://github.com/frontainer/frontnote-template)\n\nテンプレートはfrontnote-templateを参考にカスタマイズできます\n\n## Comment Style - コメントの書き方\n\n### File overview - ファイル概要\n\nOnly 1 comment block in a file.  \n１ファイルに１つき１ブロックだけ記述できます。\n\n\t/*\n\t#overview\n\tfileoverview title\n\t\n\tfileoverview comment\n\t*/\n\n### Section - セクション\n\nSection of style guide.\n'@' means attribute of this section. (ex. @deprecated @todo)\n\n各スタイルごとに記述します。  \n@をつけるとこのセクションに属性ラベルをつけることができます（例: @非推奨, @todo）\n\n\t/*\n\t#styleguide\n\tstyle title\n\n\tstyle comment.\n\n\t@deprecated\n\t@非推奨\n\t@todo\n\t@your-attribute\n\n\t```\n\tsample code here.\n\t```\n\t*/\n\n\n### Color Pallet - カラーパレット\n\nCreate color guide\nカラーガイドを作成します。\n\n\t/*\n\t#colors\n\n\t@primary #996600\n\t@secondary #333\n\t@color-name color-code\n\t*/\n\n## Test\n\n```\nnpm install\nnpm test\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontainer%2Ffrontnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrontainer%2Ffrontnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontainer%2Ffrontnote/lists"}