fix: Fully type location-enabled output (#14)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: Twixes

src/index.ts

@@ -1,6 +1,11 @@
 import grammar from './pep-508.ohm-bundle'
 import { RequirementsSyntaxError, semantics } from './semantics'
-import { LooseProjectNameRequirement, Requirement, WithLocation } from './types'
+import {
+    LooseProjectNameRequirement,
+    Requirement,
+    LooseProjectNameRequirementWithLocation,
+    RequirementWithLocation,
+} from './types'
 
 export { RequirementsSyntaxError } from './semantics'
 export * from './types'
@@ -10,11 +15,11 @@ export function parsePipRequirementsFile(fileContent: string): Requirement[]
 export function parsePipRequirementsFile(
     fileContent: string,
     options: { includeLocations: true }
-): WithLocation<Requirement>[]
+): RequirementWithLocation[]
 export function parsePipRequirementsFile(
     fileContent: string,
     options?: { includeLocations?: boolean }
-): Requirement[] | WithLocation<Requirement>[] {
+): Requirement[] | RequirementWithLocation[] {
     const matchResult = grammar.match(fileContent, 'File')
     if (matchResult.failed()) {
         throw new RequirementsSyntaxError(`Failed to parse requirements file. ${matchResult.shortMessage}`)
@@ -31,11 +36,11 @@ export function parsePipRequirementsLine(lineContent: string): Requirement | nul
 export function parsePipRequirementsLine(
     lineContent: string,
     options: { includeLocations: true }
-): WithLocation<Requirement> | null
+): RequirementWithLocation | null
 export function parsePipRequirementsLine(
     lineContent: string,
     options?: { includeLocations?: boolean }
-): Requirement | WithLocation<Requirement> | null {
+): Requirement | RequirementWithLocation | null {
     const matchResult = grammar.match(lineContent, 'Line')
     if (matchResult.failed()) {
         throw new RequirementsSyntaxError(`Failed to parse requirements line. ${matchResult.shortMessage}`)
@@ -52,11 +57,11 @@ export function parsePipRequirementsFileLoosely(fileContent: string): LooseProje
 export function parsePipRequirementsFileLoosely(
     fileContent: string,
     options: { includeLocations: true }
-): WithLocation<LooseProjectNameRequirement>[]
+): LooseProjectNameRequirementWithLocation[]
 export function parsePipRequirementsFileLoosely(
     fileContent: string,
     options?: { includeLocations?: boolean }
-): LooseProjectNameRequirement[] | WithLocation<LooseProjectNameRequirement>[] {
+): LooseProjectNameRequirement[] | LooseProjectNameRequirementWithLocation[] {
     const matchResult = grammar.match(fileContent, 'LooseFile')
     if (matchResult.failed()) {
         throw new RequirementsSyntaxError(`Failed to loosely parse requirements file. ${matchResult.shortMessage}`)
@@ -73,11 +78,11 @@ export function parsePipRequirementsLineLoosely(lineContent: string): LooseProje
 export function parsePipRequirementsLineLoosely(
     lineContent: string,
     options: { includeLocations: true }
-): WithLocation<LooseProjectNameRequirement> | null
+): LooseProjectNameRequirementWithLocation | null
 export function parsePipRequirementsLineLoosely(
     lineContent: string,
     options?: { includeLocations?: boolean }
-): LooseProjectNameRequirement | WithLocation<LooseProjectNameRequirement> | null {
+): LooseProjectNameRequirement | LooseProjectNameRequirementWithLocation | null {
     const matchResult = grammar.match(lineContent, 'LooseLine')
     if (matchResult.failed()) {
         throw new RequirementsSyntaxError(`Failed to loosely parse requirements line. ${matchResult.shortMessage}`)

src/types.ts

@@ -125,6 +125,8 @@ export interface LooseVersionSpec {
     version?: string
 }
 
+// Location-enabled types
+
 export interface SourceLocation {
     startIdx: number
     endIdx: number
@@ -134,3 +136,58 @@ export interface WithLocation<T> {
     data: T
     location: SourceLocation
 }
+
+// WithLocation variants for project requirements
+export interface ProjectNameRequirementWithLocation extends ProjectRequirementBaseWithLocation {
+    type: 'ProjectName'
+    versionSpec?: WithLocation<VersionSpecWithLocation>[]
+}
+
+export interface ProjectURLRequirementWithLocation extends ProjectRequirementBaseWithLocation {
+    type: 'ProjectURL'
+    url: WithLocation<string>
+}
+
+interface ProjectRequirementBaseWithLocation {
+    name: WithLocation<string>
+    extras?: WithLocation<string>[]
+    environmentMarkerTree?: EnvironmentMarker
+}
+
+// WithLocation variants for file requirements
+export interface RequirementsFileRequirementWithLocation extends FileRequirementBaseWithLocation {
+    type: 'RequirementsFile'
+}
+
+export interface ConstraintsFileRequirementWithLocation extends FileRequirementBaseWithLocation {
+    type: 'ConstraintsFile'
+}
+
+interface FileRequirementBaseWithLocation {
+    path: string
+}
+
+export interface VersionSpecWithLocation {
+    operator: WithLocation<VersionOperator>
+    version: WithLocation<string>
+}
+
+export interface LooseProjectNameRequirementData {
+    type: 'ProjectName'
+    name: WithLocation<string>
+    versionSpec?: WithLocation<LooseVersionSpecWithLocation>[]
+    extras?: WithLocation<string>[]
+}
+
+export interface LooseVersionSpecWithLocation {
+    operator: WithLocation<string>
+    version?: WithLocation<string>
+}
+
+export type RequirementWithLocation =
+    | WithLocation<ProjectNameRequirementWithLocation>
+    | WithLocation<ProjectURLRequirementWithLocation>
+    | WithLocation<RequirementsFileRequirementWithLocation>
+    | WithLocation<ConstraintsFileRequirementWithLocation>
+
+export type LooseProjectNameRequirementWithLocation = WithLocation<LooseProjectNameRequirementData>