@magic/semver 0.0.17 → 0.0.19

package/README.md

@@ -118,6 +118,14 @@ update dependencies
 - add typescript
 - update dependencies
 
-##### 0.0.18 - unreleased
+##### 0.0.18
+
+- fix handling a v in front of the version, eg v0.0.1
+
+##### 0.0.19
+
+- better type exports
+
+##### 0.0.20 - unreleased
 
 ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/semver",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "author": "Wizards & Witches",
   "description": "semantic version parsing and serialization.",
   "license": "AGPL-3.0",

package/src/bump.js

@@ -7,10 +7,6 @@ import { isSemver } from './isSemver.js'
 
 const libName = '@magic/semver.bump'
 
-/**
- *  @typedef {import('./types.js').Version} Version
- */
-
 /**
  * @param {string} v
  * @param {object} options
@@ -19,14 +15,14 @@ const libName = '@magic/semver.bump'
  * @param {boolean} [options.patch]
  * @param {boolean} [options.beta]
  * @param {boolean} [options.alpha]
- * @returns {Version | string}
+ * @returns {import('./types.js').Version | string}
  */
 export const bump = (v, options = {}) => {
   if (is.empty(v)) {
     throw error(`${libName} expects arguments to be non-empty`, 'E_VERSION_EMPTY')
   }
 
-  /** @type {Partial<Version> } */
+  /** @type {Partial<import('./types.js').Version> } */
   let version
 
   const isString = is.string(v)

package/src/index.js

@@ -12,6 +12,9 @@ export const parse = p
 export const stringify = s
 export const serialize = s
 
+/** @typedef {import('./types.js').Version} Version */
+/** @typedef {import('./types.js').VersionResult} VersionResult */
+
 export default {
   bump,
   isBigger,

package/src/isSemver.js

@@ -3,12 +3,8 @@ import { parse } from './parse.js'
 import { serialize } from './serialize.js'
 
 /**
- * @typedef {import('./types.js').Version} Version
- */
-
-/**
- * @param {Version | string | unknown} v
- * @returns {v is Version}
+ * @param {import('./types.js').Version | string | unknown} v
+ * @returns {v is import('./types.js').Version}
  *
  */
 export const isSemver = v => {

package/src/parse.js

@@ -3,14 +3,9 @@ import error from '@magic/error'
 
 const libName = `@magic/semver.parse:`
 
-/**
- * @typedef {import('./types.js').Version} Version
- * @typedef {import('./types.js').VersionResult} VersionResult
- */
-
 /**
  * @param {string} v
- * @returns {VersionResult}
+ * @returns {import('./types.js').VersionResult}
  */
 export const parse = v => {
   if (is.empty(v)) {
@@ -27,9 +22,9 @@ export const parse = v => {
 
   const [major, minor, patch, demo] = v.split('.')
 
-  /** @type {VersionResult} */
+  /** @type {import('./types.js').VersionResult} */
   const result = {
-    major: parseInt(major),
+    major: parseInt(major.replace('v', '')),
     minor: parseInt(minor),
     patch: -1,
     v,
@@ -48,7 +43,7 @@ export const parse = v => {
   }
 
   if (!is.number(result.major)) {
-    throw error(`${libName} major was not an Int: ${result.major}`, 'E_MAJOR_TYPE')
+    throw error(`${libName} major was not an Int: ${v} ${result.major}`, 'E_MAJOR_TYPE')
   } else if (!is.number(result.minor)) {
     throw error(`${libName} minor was not an Int: ${result.minor}`, 'E_MINOR_TYPE')
   } else if (!is.number(result.patch)) {

package/src/serialize.js

@@ -4,11 +4,7 @@ import error from '@magic/error'
 const libName = `@magic/semver.serialize:`
 
 /**
- *  @typedef {import('./types.js').Version} Version
- */
-
-/**
- * @param {Version | unknown} v
+ * @param {import('./types.js').Version | unknown} v
  * @returns {string}
  */
 export const serialize = v => {
@@ -55,5 +51,7 @@ export const serialize = v => {
     demoString = `-${string}.${version}`
   }
 
-  return `${major}.${minor}.${patch}${demoString}`
+  const prefix = is.str(v.v) && v.v.startsWith('v') ? 'v' : ''
+
+  return `${prefix}${major}.${minor}.${patch}${demoString}`
 }

package/types/bump.d.ts

@@ -7,5 +7,4 @@ export function bump(
     beta?: boolean | undefined
     alpha?: boolean | undefined
   },
-): Version | string
-export type Version = import('./types.js').Version
+): import('./types.js').Version | string

package/types/index.d.ts

@@ -7,13 +7,15 @@ export const bump: (
     beta?: boolean | undefined
     alpha?: boolean | undefined
   },
-) => Version | string
+) => import('./types.js').Version | string
 export const isBigger: (a: string, b: string) => boolean
-export const isSemver: (v: Version | string | unknown) => v is Version
+export const isSemver: (
+  v: import('./types.js').Version | string | unknown,
+) => v is import('./types.js').Version
 export const isSmaller: (a: string, b: string) => boolean
-export const parse: (v: string) => VersionResult
-export const stringify: (v: Version | unknown) => string
-export const serialize: (v: Version | unknown) => string
+export const parse: (v: string) => import('./types.js').VersionResult
+export const stringify: (v: import('./types.js').Version | unknown) => string
+export const serialize: (v: import('./types.js').Version | unknown) => string
 declare namespace _default {
   export { bump }
   export { isBigger }
@@ -24,3 +26,5 @@ declare namespace _default {
   export { stringify }
 }
 export default _default
+export type Version = import('./types.js').Version
+export type VersionResult = import('./types.js').VersionResult

package/types/isSemver.d.ts

@@ -1,2 +1,3 @@
-export function isSemver(v: Version | string | unknown): v is Version
-export type Version = import('./types.js').Version
+export function isSemver(
+  v: import('./types.js').Version | string | unknown,
+): v is import('./types.js').Version

package/types/parse.d.ts

@@ -1,3 +1 @@
-export function parse(v: string): VersionResult
-export type Version = import('./types.js').Version
-export type VersionResult = import('./types.js').VersionResult
+export function parse(v: string): import('./types.js').VersionResult

package/types/serialize.d.ts

@@ -1,2 +1 @@
-export function serialize(v: Version | unknown): string
-export type Version = import('./types.js').Version
+export function serialize(v: import('./types.js').Version | unknown): string