Skip to content

TypeScript types #23

@badsyntax

Description

@badsyntax

Is your feature request related to a problem? Please describe.

I'm using your library in a typescript project, and no existing types exist, so I have to make my own types.

Describe the solution you'd like

It would be useful if the library could publish it's own types.

Additional context

Here are the types I'm using:

declare module 'vs-parse' {
  type Package = {
    name: string;
    targetFramework?: string;
    version: string;
  };
  type Project = {
    codeFiles: string[];
    id: string;
    name: string;
    packages?: Package[];
    projectTypeId: string;
    relativePath: string;
  };
  type Solution = {
    fileFormatVersion: string;
    visualStudioVersion: string;
    minimumVisualStudioVersion: string;
    projects: Project[];
  };
  export function parseSolution(
    path: string,
    opts?: {
      deepParse: boolean;
    },
  ): Promise<Solution>;
  export function parseProject(
    path: string,
    opts?: {
      deepParse: boolean;
    },
  ): Promise<Project>;
}

It should be somewhat straightforward to include those types in the package. I'll try send a PR when I get some time.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions