cadl/packages/library-linter
Christopher Radek 1455928d25
TypeSpec 0.59 - August 2024 Release branch (#4120)
Co-authored-by: Christopher Radek <Christopher.Radek@microsoft.com>
2024-08-08 04:54:25 +00:00
..
src Migrate test framework to vitest (#2769) 2024-01-02 11:40:29 -08:00
test Migrate test framework to vitest (#2769) 2024-01-02 11:40:29 -08:00
CHANGELOG.json Prepare Publish for January Release (#2816) 2024-01-24 11:14:23 -08:00
CHANGELOG.md TypeSpec 0.59 - August 2024 Release branch (#4120) 2024-08-08 04:54:25 +00:00
LICENSE Add library linter package (#424) 2022-05-19 08:20:12 -07:00
README.md Clean up capitalization, parentheses, and phrasing in docs (#2817) 2024-01-25 10:40:16 -08:00
package.json TypeSpec 0.59 - August 2024 Release branch (#4120) 2024-08-08 04:54:25 +00:00
tsconfig.config.json Vitest improvements: vitest-ui, watch mode for deps, debug config (#2791) 2024-01-22 09:56:55 -08:00
tsconfig.json Vitest improvements: vitest-ui, watch mode for deps, debug config (#2791) 2024-01-22 09:56:55 -08:00
vitest.config.ts Vitest improvements: vitest-ui, watch mode for deps, debug config (#2791) 2024-01-22 09:56:55 -08:00

README.md

TypeSpec Library Linter

Installation

Install the package as a dev dependency.

npm install -D @typespec/library-linter

Usage

Compile your library package. Any errors or warnings will be reported as TypeSpec diagnostics.

# At the root of your TypeSpec library.
tsp compile . --import @typespec/library-linter

TypeSpec Library Best rules and best practices

Rule name Description
missing-namespace Validate that every exported element from the library (models, JS functions, operations, etc.) is in a namespace.