{"id":13668890,"url":"https://github.com/github/task_list","last_synced_at":"2025-10-04T07:31:04.495Z","repository":{"id":7518857,"uuid":"8869566","full_name":"github/task_list","owner":"github","description":"GitHub flavor Markdown Task List feature components","archived":true,"fork":false,"pushed_at":"2016-09-27T19:19:08.000Z","size":132,"stargazers_count":346,"open_issues_count":0,"forks_count":55,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-09-25T19:17:14.336Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CoffeeScript","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/github.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-19T02:57:10.000Z","updated_at":"2025-08-17T21:12:22.000Z","dependencies_parsed_at":"2022-08-29T21:42:26.749Z","dependency_job_id":null,"html_url":"https://github.com/github/task_list","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/github/task_list","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Ftask_list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Ftask_list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Ftask_list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Ftask_list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/task_list/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Ftask_list/sbom","scorecard":{"id":428238,"data":{"date":"2025-08-11","repo":{"name":"github.com/github/task_list","commit":"ed37a0774b127c7364e0203fb0d606e569789e34"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"name":"Code-Review","score":2,"reason":"Found 6/27 approved changesets -- score normalized to 2","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":"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":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: npmCommand not pinned by hash: script/bootstrap:10","Info:   0 out of   1 npmCommand dependencies pinned"],"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":"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":"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":"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":"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: 'allow deletion' enabled on branch 'master'","Warn: 'force pushes' enabled on branch 'master'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'master'","Warn: could not determine whether codeowners review is allowed","Warn: no status checks found to merge onto branch 'master'","Warn: PRs are not required to make changes on branch 'master'; or we don't have data to detect it.If you think it might be the latter, make sure to run Scorecard with a PAT or use Repo Rules (that are always public) instead of Branch Protection settings"],"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":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/github/.github/SECURITY.md:1","Info: Found linked content: github.com/github/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/github/.github/SECURITY.md:1","Info: Found text in security policy: github.com/github/.github/SECURITY.md:1"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 12 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-19T02:43:26.158Z","repository_id":7518857,"created_at":"2025-08-19T02:43:26.158Z","updated_at":"2025-08-19T02:43:26.158Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278283485,"owners_count":25961309,"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-04T02:00:05.491Z","response_time":63,"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":[],"created_at":"2024-08-02T08:00:52.546Z","updated_at":"2025-10-04T07:31:04.233Z","avatar_url":"https://github.com/github.png","language":"CoffeeScript","funding_links":[],"categories":["CoffeeScript"],"sub_categories":[],"readme":"# Task Lists\n\n*NOTE:* _This repository is no longer supported or updated by GitHub. If you wish to continue to develop this code yourself, we recommend you fork it._\u003c/code\u003e\n\n\n[![Gem Version](http://img.shields.io/gem/v/task_list.svg)][gem]\n[![Build Status](http://img.shields.io/travis/github/task_list.svg)][travis]\n[![Dependency Status](http://img.shields.io/gemnasium/github/task_list.svg)][gemnasium]\n[![Inline docs](http://inch-ci.org/github/github/task_list.svg?branch=master)][inchpages]\n\n[gem]: https://rubygems.org/gems/task_list\n[travis]: https://travis-ci.org/github/task_list\n[gemnasium]: https://gemnasium.com/github/task_list\n[inchpages]: http://inch-ci.org/github/github/task_list\n\nThis package provides various components necessary for integrating\n[Task Lists](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)\ninto your GitHub-flavored-Markdown user content.\n\n## Components\n\nThe Task List feature is made of several different components:\n\n* GitHub-flavored-Markdown Ruby Filter\n* Summary Ruby Model: summarizes task list items\n* JavaScript: frontend task list update behavior\n* CSS: styles Markdown task list items\n\n## Usage \u0026 Integration\n\nThe backend components are designed for rendering the Task List item checkboxes, and the frontend components handle updating the Markdown source (embedded in the markup).\n\n### Backend: Markdown pipeline filter\n\nRendering Task List item checkboxes from source Markdown depends on the `TaskList::Filter`, designed to integrate with the [`html-pipeline`](https://github.com/jch/html-pipeline) gem. For example:\n\n``` ruby\nrequire 'html/pipeline'\nrequire 'task_list/filter'\n\npipeline = HTML::Pipeline.new [\n  HTML::Pipeline::MarkdownFilter,\n  TaskList::Filter\n]\n\npipeline.call \"- [ ] task list item\"\n```\n\n### Frontend: Markdown Updates\n\nTask List updates on the frontend require specific HTML markup structure, and must be enabled with JavaScript.\n\nRendered HTML (the `\u003cul\u003e` element below) should be contained in a `js-task-list-container` container element and include a sibling `textarea.js-task-list-field` element that is updated when checkboxes are changed.\n\n``` markdown\n- [ ] text\n```\n\n``` html\n\u003cdiv class=\"js-task-list-container\"\u003e\n  \u003cul class=\"task-list\"\u003e\n    \u003cli class=\"task-list-item\"\u003e\n      \u003cinput type=\"checkbox\" class=\"js-task-list-item-checkbox\" disabled /\u003e\n      text\n    \u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cform\u003e\n    \u003ctextarea class=\"js-task-list-field\"\u003e- [ ] text\u003c/textarea\u003e\n  \u003c/form\u003e\n\u003c/div\u003e\n```\n\nEnable Task List updates with:\n\n``` javascript\n$('.js-task-list-container').taskList('enable')\n```\n\nNOTE: Updates are not persisted to the server automatically. Persistence is the responsibility of the integrating application, accomplished by hooking into the `tasklist:change` JavaScript event. For instance, we use AJAX to submit a hidden form on update.\n\nRead through the documented behaviors and samples [in the source][frontend_behaviors] for more detail, including documented events.\n\n[frontend_behaviors]: https://github.com/github/task_list/blob/master/app/assets/javascripts/task_list.coffee\n\n## Installation\n\nTask Lists are packaged as both a RubyGem with both backend and frontend behavior, and a Bower package with just the frontend behavior.\n\n### Backend: RubyGem\n\nFor the backend Ruby components, add this line to your application's Gemfile:\n\n    gem 'task_list'\n\nAnd then execute:\n\n    $ bundle\n\n### Frontend: Bower\n\nFor the frontend components, add `task_list` to your Bower dependencies config.\n\nThis is the preferred method for including the frontend assets in your application. Alternatively, for Rails methods using `Sprockets`, see below.\n\n### Frontend: Rails 3+ Railtie method\n\n``` ruby\n# config/application.rb\nrequire 'task_list/railtie'\n```\n\n### Frontend: Rails 2.3 Manual method\n\nWherever you have your Sprockets setup:\n\n``` ruby\nSprockets::Environment.new(Rails.root) do |env|\n  # Load TaskList assets\n  require 'task_list/railtie'\n  TaskList.asset_paths.each do |path|\n    env.append_path path\n  end\nend\n```\n\nIf you're not using Sprockets, you're on your own but it's pretty straight\nforward. `task_list/railtie` defines `TaskList.asset_paths` which you can use\nto manage building your asset bundles.\n\n### Dependencies\n\nAt a high level, the Ruby components integrate with the [`html-pipeline`](https://github.com/jch/html-pipeline) library, and the frontend components depend on the jQuery library. The frontend components are written in CoffeeScript and need to be preprocessed for production use.\n\n## Testing and Development\n\nJavaScript unit tests can be run with `script/testsuite`.\n\nRuby unit tests can be run with `rake test`.\n\nFunctional tests are useful for manual testing in the browser. To run, install\nthe necessary components with `script/bootstrap` then run the server:\n\n```\nrackup -p 4011\n```\n\nNavigate to http://localhost:4011/test/functional/test_task_lists_behavior.html\n\n## Community Integration\n- [Waffle.io](http://waffle.io)\n- [HuBoard](https://huboard.com/)\n\n## Contributing\n\nRead the [Contributing Guidelines](CONTRIBUTING.md) and open a Pull Request!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Ftask_list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Ftask_list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Ftask_list/lists"}