Filemedium importancesource

pyright.ts

utils/bash/specs/pyright.ts

No strong subsystem tag
92
Lines
2670
Bytes
0
Exports
1
Imports
10
Keywords

What this is

This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.

Beginner explanation

This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.

How it is used

Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.

Expert explanation

Architecturally, this file intersects with general runtime concerns. It contains 92 lines, 1 detected imports, and 0 detected exports.

Important relationships

Detected exports

  • No clear exports detected.

Keywords

namedescriptionargsfiledirectoryversionpythonanalyzelevelcommandspec

Detected imports

  • ../registry.js

Source notes

This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.

Open parent directory

Full source

import type { CommandSpec } from '../registry.js'

export default {
  name: 'pyright',
  description: 'Type checker for Python',
  options: [
    { name: ['--help', '-h'], description: 'Show help message' },
    { name: '--version', description: 'Print pyright version and exit' },
    {
      name: ['--watch', '-w'],
      description: 'Continue to run and watch for changes',
    },
    {
      name: ['--project', '-p'],
      description: 'Use the configuration file at this location',
      args: { name: 'FILE OR DIRECTORY' },
    },
    { name: '-', description: 'Read file or directory list from stdin' },
    {
      name: '--createstub',
      description: 'Create type stub file(s) for import',
      args: { name: 'IMPORT' },
    },
    {
      name: ['--typeshedpath', '-t'],
      description: 'Use typeshed type stubs at this location',
      args: { name: 'DIRECTORY' },
    },
    {
      name: '--verifytypes',
      description: 'Verify completeness of types in py.typed package',
      args: { name: 'IMPORT' },
    },
    {
      name: '--ignoreexternal',
      description: 'Ignore external imports for --verifytypes',
    },
    {
      name: '--pythonpath',
      description: 'Path to the Python interpreter',
      args: { name: 'FILE' },
    },
    {
      name: '--pythonplatform',
      description: 'Analyze for platform',
      args: { name: 'PLATFORM' },
    },
    {
      name: '--pythonversion',
      description: 'Analyze for Python version',
      args: { name: 'VERSION' },
    },
    {
      name: ['--venvpath', '-v'],
      description: 'Directory that contains virtual environments',
      args: { name: 'DIRECTORY' },
    },
    { name: '--outputjson', description: 'Output results in JSON format' },
    { name: '--verbose', description: 'Emit verbose diagnostics' },
    { name: '--stats', description: 'Print detailed performance stats' },
    {
      name: '--dependencies',
      description: 'Emit import dependency information',
    },
    {
      name: '--level',
      description: 'Minimum diagnostic level',
      args: { name: 'LEVEL' },
    },
    {
      name: '--skipunannotated',
      description: 'Skip type analysis of unannotated functions',
    },
    {
      name: '--warnings',
      description: 'Use exit code of 1 if warnings are reported',
    },
    {
      name: '--threads',
      description: 'Use up to N threads to parallelize type checking',
      args: { name: 'N', isOptional: true },
    },
  ],
  args: {
    name: 'files',
    description:
      'Specify files or directories to analyze (overrides config file)',
    isVariadic: true,
    isOptional: true,
  },
} satisfies CommandSpec