{"id":28700689,"url":"https://github.com/tryghost/gscan","last_synced_at":"2026-01-25T06:01:47.267Z","repository":{"id":21658602,"uuid":"24979466","full_name":"TryGhost/gscan","owner":"TryGhost","description":"Ghost theme scanner - checks for errors and feature support","archived":false,"fork":false,"pushed_at":"2026-01-23T21:37:44.000Z","size":4862,"stargazers_count":81,"open_issues_count":41,"forks_count":59,"subscribers_count":17,"default_branch":"main","last_synced_at":"2026-01-24T09:55:43.007Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://gscan.ghost.org","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/TryGhost.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"tryghost","open_collective":"ghost"}},"created_at":"2014-10-09T08:05:01.000Z","updated_at":"2026-01-21T22:35:52.000Z","dependencies_parsed_at":"2023-07-25T00:03:26.618Z","dependency_job_id":"adc12b5a-3d30-4867-b8a7-3345d84f7e76","html_url":"https://github.com/TryGhost/gscan","commit_stats":{"total_commits":1593,"total_committers":63,"mean_commits":"25.285714285714285","dds":0.7664783427495292,"last_synced_commit":"5d52a65f1412eb1a24424095e456dc7a64390253"},"previous_names":["erisds/ghost-theme-check"],"tags_count":223,"template":false,"template_full_name":null,"purl":"pkg:github/TryGhost/gscan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TryGhost%2Fgscan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TryGhost%2Fgscan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TryGhost%2Fgscan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TryGhost%2Fgscan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TryGhost","download_url":"https://codeload.github.com/TryGhost/gscan/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TryGhost%2Fgscan/sbom","scorecard":{"id":46578,"data":{"date":"2025-08-11","repo":{"name":"github.com/TryGhost/gscan","commit":"d3782519ec297d91d905e1e545f534a8b41b1baf"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.8,"checks":[{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: 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":"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":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Code-Review","score":0,"reason":"Found 1/29 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":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/check-links.yml:1","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/deploy.yml:1","Info: no jobLevel write permissions found"],"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":"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":"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":"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":"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":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-links.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/TryGhost/gscan/check-links.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/TryGhost/gscan/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/TryGhost/gscan/deploy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/TryGhost/gscan/deploy.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:2","Warn: containerImage not pinned by hash: Dockerfile:9","Warn: containerImage not pinned by hash: Dockerfile:19","Info:   2 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 third-party GitHubAction dependencies pinned","Info:   0 out of   3 containerImage 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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 17 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":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-qgmg-gppg-76g5"],"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-14T22:54:20.301Z","repository_id":21658602,"created_at":"2025-08-14T22:54:20.301Z","updated_at":"2025-08-14T22:54:20.301Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28745836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T05:12:38.112Z","status":"ssl_error","status_checked_at":"2026-01-25T05:04:50.338Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2025-06-14T11:30:35.310Z","updated_at":"2026-01-25T06:01:47.262Z","avatar_url":"https://github.com/TryGhost.png","language":"JavaScript","funding_links":["https://github.com/sponsors/tryghost","https://opencollective.com/ghost"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://gscan.ghost.org/\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/TryGhost/gscan/main/app/public/logo-gscan-black.png\" width=\"216px\" alt=\"Ghost\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nGScan is a tool for validating Ghost themes. It produces detailed reports of issues where themes need to be modified in order to be compatible with a specific version.\n\nIt is actively capable of dealing with the current and last major versions of Ghost (v1-v6).\n\nGScan works on a system of rules. Each rule has a way to check whether it passes or fails and has help content which describes how to fix it. Each rule is also marked with an error level:\n\n- Errors: issues that will cause your theme to not work properly. These must be fixed.\n- Warnings: these are usually related to deprecated features. These should be fixed.\n- Recommendations: these are advisories about best practice. Fixing these will improve your theme.\n- Features: detected features which may impact on compatibility. Nothing to do!\n\nIn addition, an **error** can be marked as **fatal**. A **fatal error** means, left unchecked a Ghost publication would throw 500 errors on certain pages because of the detected out-of-date or erroneous code.\n\n## Usage\n\nThere are 4 ways to use gscan to validate your theme:\n\n### 1. Inside Ghost\n\nGscan is pre-installed in Ghost. If there are theme errors, Ghost will show them on boot in the console logs and in the UI (Ghost Admin).\n\n### 2. Web usage\n\nVisit https://gscan.ghost.org and upload your zip to our online version of Gscan.\n\n### 3. CLI usage\n\nInstall using yarn / npm:\n\n`yarn global add gscan` /  `npm install -g gscan`\n\nTo run a local directory through the checks:\n\n`gscan /path/to/theme/directory`\n\nTo run a local zip file through the checks:\n\n`gscan /path/to/theme.zip -z`\n\nBy default, GScan scans themes for the latest Ghost version compatibility. You can also specify a Ghost version by using the following parameters (for Ghost 1.0, 2.0, 3.0, 4.0, 5.0 and 6.0):\n\n`--v1` or `-1`\n`--v2` or `-2`\n`--v3` or `-3`\n`--v4` or `-4`\n`--v5` or `-5`\n`--v6` or `-6` (default) or `--canary`\n\nExamples:\n\n`gscan /path/to/theme.zip -z -1` - scan a theme in a zip file for Ghost 1.0 compatibility\n`gscan /path/to/theme/directory --v2` - can a theme in a directory for Ghost 2.0 compatibility\n`gscan /path/to/theme/directory` - scan a theme for Ghost 6.0 compatibility\n\n### 4. Lib usage\n\nInstall using yarn/npm and then:\n\n```js\nvar gscan = require('gscan');\n\ngscan.checkZip({\n    path: 'path-to-zip',\n    // Pass in a folder to check\n    // if you need to check the theme for a different\n    // major Ghost version, you can pass it. Currently\n    // v1, v2, v3, v4, v5 and v6 are supported. Default is\n    // the latest Ghost version 6.0:\n    // checkVersion: 'v6',\n    name: 'my-theme'\n}).then(function (result) {\n    console.log(result);\n}).catch(function(err) {\n    console.log(err);\n});\n```\n\n## Development\n\n### Run in browser (for zip uploads)\n\n- Either dev mode: `yarn dev`\n- Or standard server: `yarn start`\n- View: http://localhost:2369\n\n### Run on command line\n\n- zip file: `./bin/cli.js -z /path/to/your/theme.zip`\n- directory: `./bin/cli.js /path/to/directory`\n\n### Publish\n\n(Core team only)\n\n- `yarn ship`\n\n### Tools\nWhen developing new rules or testing gscan following tools are great to have in the toolbelt:\n- [astexplorer](https://astexplorer.net) - absolutely awesome Handlebars AST fiddler, helpful when testing out new ideas and exploring what's possible through AST parser;\n\n## To Do\n\n- Support for running the checks against a GitHub repository\n- Many, many more checks\n- Detailed advice for each check/result\n- Compatibility report\n- Feature listing\n\n# Copyright \u0026 License\n\nCopyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryghost%2Fgscan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftryghost%2Fgscan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryghost%2Fgscan/lists"}