├── .editorconfig ├── .gitattributes ├── .github ├── funding.yml ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: sindresorhus 2 | open_collective: sindresorhus 3 | tidelift: npm/remote-git-tags 4 | custom: https://sindresorhus.com/donate 5 | -------------------------------------------------------------------------------- /.github/security.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. 4 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | steps: 15 | - uses: actions/checkout@v2 16 | - uses: actions/setup-node@v2 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - run: npm install 20 | - run: npm test 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import {promisify} from 'node:util'; 2 | import childProcess from 'node:child_process'; 3 | 4 | const execFile = promisify(childProcess.execFile); 5 | 6 | export default async function remoteGitTags(repoUrl) { 7 | const {stdout} = await execFile('git', ['ls-remote', '--tags', repoUrl]); 8 | const tags = new Map(); 9 | 10 | for (const line of stdout.trim().split('\n')) { 11 | const [hash, tagReference] = line.split('\t'); 12 | 13 | // Strip off the indicator of dereferenced tags so we can override the 14 | // previous entry which points at the tag hash and not the commit hash 15 | // `refs/tags/v9.6.0^{}` → `v9.6.0` 16 | const tagName = tagReference.replace(/^refs\/tags\//, '').replace(/\^{}$/, ''); 17 | 18 | tags.set(tagName, hash); 19 | } 20 | 21 | return tags; 22 | } 23 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "remote-git-tags", 3 | "version": "4.0.0", 4 | "description": "Get tags from a remote Git repo", 5 | "license": "MIT", 6 | "repository": "sindresorhus/remote-git-tags", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": "^12.20.0 || ^14.13.1 || >=16.0.0" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava" 20 | }, 21 | "files": [ 22 | "index.js" 23 | ], 24 | "keywords": [ 25 | "git", 26 | "tags", 27 | "tag", 28 | "remote", 29 | "ls-remote", 30 | "ls", 31 | "repo", 32 | "repository", 33 | "commit", 34 | "sha", 35 | "url" 36 | ], 37 | "devDependencies": { 38 | "ava": "^3.15.0", 39 | "xo": "^0.44.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # remote-git-tags 2 | 3 | > Get tags from a remote Git repo 4 | 5 | ## Install 6 | 7 | ``` 8 | $ npm install remote-git-tags 9 | ``` 10 | 11 | The `git` binary must be installed and in your [PATH](https://medium.com/@jalendport/what-exactly-is-your-shell-path-2f076f02deb4). 12 | 13 | ## Usage 14 | 15 | ```js 16 | import remoteGitTags from 'remote-git-tags'; 17 | 18 | console.log(await remoteGitTags('https://github.com/sindresorhus/remote-git-tags')); 19 | //=> Map {'v1.0.0' => '69e308412e2a5cffa692951f0274091ef23e0e32', …} 20 | ``` 21 | 22 | ## API 23 | 24 | ### remoteGitTags(repoUrl) 25 | 26 | Returns a `Promise>` with the Git tags as keys and their commit SHA as values. 27 | 28 | #### repoUrl 29 | 30 | Type: `string` 31 | 32 | The URL to the Git repo. 33 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import remoteGitTags from './index.js'; 3 | 4 | test('main', async t => { 5 | const tags = await remoteGitTags('https://github.com/sindresorhus/got'); 6 | t.is(tags.get('v6.0.0'), 'e5c2d9e93137263c68db985b3dc5b57865c67b82'); 7 | t.is(tags.get('v5.0.0'), '0933d0bb13f704bc9aabcc1eec7a8e33dc8aba51'); 8 | }); 9 | --------------------------------------------------------------------------------