{"id":17997301,"url":"https://github.com/malukenho/docheader","last_synced_at":"2025-04-07T16:18:50.496Z","repository":{"id":8727101,"uuid":"59521047","full_name":"malukenho/docheader","owner":"malukenho","description":"A small tool to check license headers","archived":false,"fork":false,"pushed_at":"2024-02-05T12:07:56.000Z","size":202,"stargazers_count":66,"open_issues_count":3,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-31T14:11:58.140Z","etag":null,"topics":["checker","docheader","php","placeholder"],"latest_commit_sha":null,"homepage":"https://github.com/malukenho/docheader","language":"PHP","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/malukenho.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":"2016-05-23T21:55:47.000Z","updated_at":"2025-01-17T09:37:39.000Z","dependencies_parsed_at":"2023-01-13T14:57:54.384Z","dependency_job_id":"981101a0-36cb-422e-bc78-3e279427893c","html_url":"https://github.com/malukenho/docheader","commit_stats":{"total_commits":144,"total_committers":9,"mean_commits":16.0,"dds":"0.29861111111111116","last_synced_commit":"2b577f8c8bb06462768a7746d70261b7c5c55f18"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malukenho%2Fdocheader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malukenho%2Fdocheader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malukenho%2Fdocheader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malukenho%2Fdocheader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/malukenho","download_url":"https://codeload.github.com/malukenho/docheader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247685628,"owners_count":20979085,"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","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":["checker","docheader","php","placeholder"],"created_at":"2024-10-29T21:17:39.542Z","updated_at":"2025-04-07T16:18:50.472Z","avatar_url":"https://github.com/malukenho.png","language":"PHP","readme":"# DocHeader\n\n[![Build Status](https://travis-ci.org/malukenho/docheader.svg?branch=master)](https://travis-ci.org/malukenho/docheader)\n[![Code Coverage](https://scrutinizer-ci.com/g/malukenho/docheader/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/malukenho/docheader/?branch=master)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/malukenho/docheader/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/malukenho/docheader/?branch=master)\n[![Latest Stable Version](https://poser.pugx.org/malukenho/docheader/v/stable)](https://packagist.org/packages/malukenho/docheader)\n[![Total Downloads](https://poser.pugx.org/malukenho/docheader/downloads)](https://packagist.org/packages/malukenho/docheader)\n[![Latest Unstable Version](https://poser.pugx.org/malukenho/docheader/v/unstable)](https://packagist.org/packages/malukenho/docheader)\n[![License](https://poser.pugx.org/malukenho/docheader/license)](https://packagist.org/packages/malukenho/docheader)\n\nHow much time we have wasted to change copyright years in our project?\nHow much times we forget to update it and then we're in the middle of\na new year using last year copyright dated? *That's sucks!!one!!*\n\n**Put doc header check in your build and get it out of your way!**\n\n### Installing\n\n```sh\n composer require --dev --sort-packages malukenho/docheader\n```\n\n### Setting up\n\nPut your header in one `.docheader` file in the directory that you're\nrunning the checker/fixer. It file must contain only the dockblock as\nyou want, like following example:\n\n```php\n/**\n * Zend Framework (http://framework.zend.com/)\n *\n * @link      http://github.com/zendframework/zf2 for the canonical source repository\n * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)\n * @license   http://framework.zend.com/license/new-bsd New BSD License\n */\n```\n\nand then run the checker:\n\n```sh\n./vendor/bin/docheader check src/\n```\n\nSo, you get errors or a message saying that everything is ok!\n\n### Docheader file\n\nBy default, the `docheader` search for a `.docheader` file on the current directory that\nthe command is executed. But you can specify a folder or a file to be used as placeholder\nusing the option `--docheader [file-or-path]`\n\n### Current year placeholder\n\nYou can also put `%year%` on your `.docheader` file to refer to the current\nYear, like that:\n\n```php\n/**\n * @copyright Copyright (c) 2005-%year% Zend Technologies USA Inc. (http://www.zend.com)\n */\n```\n\n### Regexp assertion\n\nIf you're using `\u003e=0.1.5` version, you can use the `%regexp:%` placeholder to match some content.\n\nExample:\n\n```php\n/**\n * @copyright Copyright (c) 20%regexp:\\d{2}%-2016 Zend Technologies USA Inc. (http://www.zend.com)\n */\n```\n\nIn this case `%regexp:\\d{2}%` assert that it should be a number of two digits between `20` and `-`.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalukenho%2Fdocheader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmalukenho%2Fdocheader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalukenho%2Fdocheader/lists"}