Skip to content
This repository was archived by the owner on Dec 19, 2025. It is now read-only.

Commit e6d234d

Browse files
axelrindleaxelrindle
committed
Move core types to new module
1 parent bf11076 commit e6d234d

13 files changed

Lines changed: 99 additions & 65 deletions

File tree

‎package-lock.json‎

Lines changed: 37 additions & 44 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/api/package.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"private": true,
3+
"name": "@github-version-checker/api",
4+
"version": "2.3.0",
5+
"description": "The common API used by all github-version-checker modules.",
6+
"exports": {
7+
".": "./src/index.ts"
8+
},
9+
"keywords": [
10+
"version-checker",
11+
"github-api"
12+
],
13+
"author": "Axel Rindle <mail@axelrindle.de>",
14+
"license": "MIT",
15+
"repository": {
16+
"type": "git",
17+
"url": "git+https://github.com/axelrindle/github-version-checker.git"
18+
},
19+
"bugs": {
20+
"url": "https://github.com/axelrindle/github-version-checker/issues"
21+
},
22+
"homepage": "https://axelrindle.github.io/github-version-checker/",
23+
"dependencies": {
24+
"@sindresorhus/tsconfig": "^3.0.1",
25+
"@types/node": "^18.11.17",
26+
"typescript": "^4.8.4"
27+
},
28+
"scripts": {
29+
"clean": "rm -rf dist",
30+
"build": "tsc"
31+
}
32+
}

packages/core/src/types.ts renamed to packages/api/src/index.ts

File renamed without changes.

‎packages/api/tsconfig.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"extends": "@sindresorhus/tsconfig",
3+
"compilerOptions": {
4+
"outDir": "dist",
5+
},
6+
"include": [
7+
"src/",
8+
]
9+
}

‎packages/cli/package.json‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@
2525
"prepublishOnly": "npm run build"
2626
},
2727
"devDependencies": {
28-
"@sindresorhus/tsconfig": "^3.0.1",
29-
"@types/node": "^18.8.0",
28+
"@github-version-checker/api": "*",
3029
"pkg": "^5.8.0",
31-
"tsx": "^3.9.0",
32-
"typescript": "^4.8.4"
30+
"tsx": "^3.9.0"
3331
},
3432
"dependencies": {
3533
"github-version-checker": "*",

‎packages/cli/src/types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { ReleaseDescriptor, TagDescriptor } from 'github-version-checker/types'
1+
import { ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
22

33
export interface CliArguments {
44
owner: string

‎packages/core/package.json‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
"version": "2.3.0",
44
"description": "Version checker working with GitHub releases.",
55
"exports": {
6-
".": "./dist/index.js",
7-
"./types": "./dist/types.d.ts"
6+
".": "./dist/index.js"
87
},
98
"main": "dist/index.js",
109
"types": "dist/index.d.ts",
@@ -27,16 +26,14 @@
2726
"semver": "^7.3.7"
2827
},
2928
"devDependencies": {
30-
"@sindresorhus/tsconfig": "^3.0.1",
31-
"@types/node": "^14.18.12",
29+
"@github-version-checker/api": "*",
3230
"@types/semver": "^7.3.12",
3331
"@typescript-eslint/eslint-plugin": "^5.38.1",
3432
"@typescript-eslint/parser": "^5.38.1",
3533
"ava": "^4.3.3",
3634
"eslint": "^8.24.0",
3735
"nyc": "^15.1.0",
38-
"ts-node": "^10.9.1",
39-
"typescript": "^4.8.4"
36+
"ts-node": "^10.9.1"
4037
},
4138
"scripts": {
4239
"clean": "rm -rf .nyc_output coverage dist",

‎packages/core/src/check.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import graphql from './query/graphql'
22
import rest from './query/rest'
3-
import { CheckOptions, ReleaseDescriptor, TagDescriptor } from './types'
3+
import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
44

55
/**
66
* Checks whether a new version is available. Depending on whether a token is given, the

‎packages/core/src/index.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import check from './check'
2-
import { CallbackFunction, CheckOptions, ReleaseDescriptor, TagDescriptor } from './types'
2+
import { CallbackFunction, CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
33

44
/**
55
* The exported checking function.
@@ -8,7 +8,10 @@ import { CallbackFunction, CheckOptions, ReleaseDescriptor, TagDescriptor } from
88
* @param callback An optional callback to pass the result to.
99
* Can be omitted to return a Promise.
1010
*/
11-
export default function versionCheck(options: CheckOptions, callback?: CallbackFunction): undefined|Promise<ReleaseDescriptor|TagDescriptor|undefined> {
11+
export default function versionCheck(
12+
options: CheckOptions,
13+
callback?: CallbackFunction
14+
): undefined|Promise<ReleaseDescriptor|TagDescriptor|undefined> {
1215
if (callback) {
1316
check(options)
1417
.then(update => callback(undefined, update))

‎packages/core/src/query/graphql.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { Octokit } from '@octokit/core'
22
import type { GraphQlQueryResponseData } from '@octokit/graphql';
33
import { gt } from 'semver'
4-
import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '../types'
4+
import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '@github-version-checker/api'
55
import { releases, tags } from '../util/graphql'
66

77
/**
@@ -41,11 +41,13 @@ export default async function graphql(options: CheckOptions): Promise<ReleaseDes
4141
return undefined
4242
}
4343

44-
// no drafts please
45-
if (! options.fetchTags) {
46-
if (entries[0].isDraft && repository.releases.pageInfo.hasNextPage) {
44+
const skip = (! options.fetchTags && entries[0].isDraft) || (options.excludePrereleases && entries[0].isPrerelease)
45+
if (skip) {
46+
if (repository.releases.pageInfo.hasNextPage) {
4747
cursor = repository.releases.pageInfo.endCursor
4848
continue
49+
} else {
50+
return undefined
4951
}
5052
}
5153

0 commit comments

Comments
 (0)