OVERVIEW: Swift IDE Test
USAGE: swift-ide-test [options] [input files...]
OPTIONS:
Generic Options:
--help - Display available options (--help-hidden for more)
--help-list - Display list of available options (--help-list-hidden for more)
--version - Display the version of this program
swift-ide-test Options:
-D <string> - Conditional compilation flags
-F <string> - add a directory to the framework search path
-I <string> - add a directory to the import search path
--Xcc=<string> - option to pass to clang
--abstract-accessors - Hide the concrete accessors used to implement a property or subscript
Access filter:
--access-filter-private - Print all declarations
--access-filter-internal - Print internal and public declarations
--access-filter-public - Print public declarations
--access-notes-path=<string> - Path to access notes file
--always-argument-labels - Whether to always print separate argument labels
--annotate-print - Annotate AST printing
--code-complete-add-call-with-no-default-args - Whether to include a function completion that contains no default arguments
--code-complete-call-pattern-heuristics - Use heuristics to guess whether we want call pattern completions
--code-complete-inits-in-postfix-expr - Include initializers when completing a postfix expression
--code-completion-annotate-results - annotate completion results with XML
--code-completion-comments - Include comments in code completion results
--code-completion-diagnostics - Print compiler diagnostics while doing code completion
--code-completion-keywords - Include keywords in code completion results
--code-completion-sourcetext - Include source texts in code completion results
--code-completion-token=<string> - Code completion token name
--comments-xml-schema=<string> - Filename of the RelaxNG schema for documentation comments
--completion-cache-path=<string> - Code completion cache path
--completion-output-dir=<path> - Directory for completion output
--conforming-methods-expected-types=<string> - Set expected types for comforming method list
--cxx-interop-getters-setters-as-properties - Imports getters and setters as computed properties.
--debug-client-discriminator=<string> - A discriminator to prefer in lookups
--debug-constraints - Enable verbose debugging from the constraint solver.
--debug-forbid-typecheck-prefix=<string> - Triggers llvm fatal_error if typechecker tries to typecheck a decl with the provided prefix name
--decl-to-print=<string> - Decl name to print swift interface for
--define-availability=<string> - Define a macro for @available
--disable-access-control - Disables access control, like a debugger
--disable-objc-attr-requires-foundation-module - Allow @objc to be used freely
--disable-objc-interop - Disable ObjC interop.
--enable-cross-import-overlays - Automatically import declared cross-import overlays.
--enable-deserialization-safety - Avoid reading potentially unsafe decls from swiftmodules
--enable-experimental-cxx-interop - Enable C++ interop.
--enable-experimental-feature=<string> - Enable an experimental feature
--enable-objc-forward-declarations - Import Objective-C forward declarations when possible
--enable-objc-interop - Enable ObjC interop.
--enable-swift3-objc-inference - Enable Swift 3's @objc inference rules
--enable-swiftsourceinfo - Whether to consume .swiftsourceinfo files
--end-pos=<string> - Line:Column pair
--explicit-swift-module-map-file=<string> - JSON file to include explicit Swift modules
--explode-pattern-binding-decls - Separate pattern binding decls into individual var decls
--expressions - Print expressions
--filecheck=<path> - Path to 'FileCheck' utility
--find-mangled=<string> - Print the entity with the given mangled name
--fully-qualified-types - Print fully qualified types
--fully-qualified-types-if-ambiguous - Print types fully-qualified if they would be ambiguous otherwise
--function-definitions - Print function bodies
--header-to-print=<string> - Header filename to print swift interface for
--iframework=<string> - add a directory to the system framework search path
--import-objc-header=<string> - header to implicitly import
--include-locals - Index local symbols too.
--load-plugin-executable=<string> - load plugin executable
--load-plugin-library=<string> - load plugin library
--module-alias=<string> - Use '-module-alias <name>=<binary_name>' to map a module of <name> that appears in source code to <binary_name>
--module-cache-path=<string> - Clang module cache path
--module-group=<string> - Name of the module group to print
--module-name=<string> - The module name of the given test.
--module-print-hidden - Print non-exported imported or submodules
--module-print-skip-overlay - Skip Swift overlay modules
--module-print-submodules - Recursively print submodules
--module-to-print=<string> - Name of the module to print
--no-empty-line-between-members - Print no empty line between members.
--parse-as-library - Parse '-source-filename' as a library source file
--pch-output-dir=<string> - place autogenerated PCH files in this directory
--playground - Whether coloring in playground
--plugin-path=<string> - plugin-path
--pos=<string> - Line:Column pair
--prefer-type-repr - When printing types, prefer printing TypeReprs
--print-access - Print access keywords for all values
Mode:
--batch-code-completion - Perform code completion in batch mode
--code-completion - Perform code completion
--repl-code-completion - Perform REPL-style code completion
--dump-completion-cache - Dump a code completion cache file
--dump-importer-lookup-table - Dump the Clang importer's lookup tables
--syntax-coloring - Perform syntax coloring
--dump-comments - Dump documentation comments attached to decls
--structure - Perform document structure annotation
--annotate - Perform semantic annotation
--test-input-complete - Check if input source is complete
--print-ast-not-typechecked - Print the non-typechecked AST
--print-ast-typechecked - Print the typechecked AST
--print-module - Print visible declarations in a module
--print-module-metadata - Print meta-data in a module
--print-header - Print visible declarations in a header file
--print-swift-file-interface - Print interface of a swift file
--print-decl - Print interface of a decl
--print-types - Print types of all subexpressions and declarations in the AST
--print-comments - Print documentation comments attached to decls
--print-module-comments - Given a module, print documentation comments attached to decls
--print-module-imports - Recursively print all imports visible from a particular module
--print-usrs - Print USRs for all decls
--print-local-types - Print local types and remanglings in a module
--test-createCompilerInvocation - Test swift::driver::createCompilerInvocation using the arguments passed to swift-ide-test (must be specified before all other arguments)
--test-CompilerInvocation-from-module - Test CompilerInvocation::loadFromSerializedAST on the "source" file
--generate-module-api-description - Generate a machine-readable description of module API
--diff-module-api - Compare machine-readable descriptions of module API
--print-type-interface - Print type-specific interface decl
--reconstruct-type - Reconstruct type from mangled name
--print-module-groups - Print group names in a module
--range - Print information about a given range
--print-indexed-symbols - Print indexed symbol information
--type-context-info - Perform expression context info analysis
--print-expr-type - Print types for all expressions in the file
--conforming-methods - Perform conforming method analysis for expression
--print-implicit-attrs - Print implicit attributes
--print-interface - Print with options set for interface printing, overrides any other printing option
--print-interface-doc - Print with options set for interface printing, for doc support; overrides any other printing option
--print-original-source - print the original source text for applicable declarations
--print-regular-comments - Print regular comments from clang module headers
--print-stats - Print statistics
--random-seed=<seed> - Seed for the random number generator
--resource-dir=<string> - The directory that holds the compiler resource files
--sdk=<string> - path to the SDK to build against
--second-source-filename=<string> - Name of the second source file
--serialized-path-obfuscate=<string> - Path to access notes file
--skip-deinit - Whether to skip printing destructors
--skip-filecheck - Skip 'FileCheck' checking
--skip-imports - Whether to skip printing import declarations
--skip-overrides - Whether to skip printing overrides/witnesses
--skip-parameter-names - Whether to skip parameter names
--skip-print-doc-comments - Don't print documentation comments from clang module headers
--skip-private-stdlib-decls - Don't print declarations that start with '_'
--skip-unavailable - Don't print unavailable declarations
--skip-underscored-stdlib-protocols - Don't print protocols that start with '_'
--skip-unsafe-cxx-methods - Don't print unsafe C++ class methods that were renamed as unsafe
--source-filename=<string> - Name of the source file
--swift-version=<string> - Swift version
--synthesize-extension - Print synthesized extensions from conforming protocols.
--synthesize-sugar-on-types - Always print Array and Optional with sugar
--target=<string> - target triple
--terminal - Use terminal color for source annotations
--tools-directory=<string> - Path to external executables (ld, clang, binutils)
--typecheck - Type check the AST
--usr=<string> - USR
--usr-filter=<string> - Filter results by the given usrs
Options (140)
| Option | Description | Source |
|---|---|---|
--help | - Display available options (--help-hidden for more) | help |
--help-list | - Display list of available options (--help-list-hidden for more) | help |
--version | - Display the version of this program | help |
-D string | - Conditional compilation flags | help |
-F string | - add a directory to the framework search path | help |
-I string | - add a directory to the import search path | help |
--Xcc string | - option to pass to clang | help |
--abstract-accessors | - Hide the concrete accessors used to implement a property or subscript | help |
--access-filter-private | - Print all declarations | help |
--access-filter-internal | - Print internal and public declarations | help |
--access-filter-public | - Print public declarations | help |
--access-notes-path string | - Path to access notes file | help |
--always-argument-labels | - Whether to always print separate argument labels | help |
--annotate-print | - Annotate AST printing | help |
--code-complete-add-call-with-no-default-args | - Whether to include a function completion that contains no default arguments | help |
--code-complete-call-pattern-heuristics | - Use heuristics to guess whether we want call pattern completions | help |
--code-complete-inits-in-postfix-expr | - Include initializers when completing a postfix expression | help |
--code-completion-annotate-results | - annotate completion results with XML | help |
--code-completion-comments | - Include comments in code completion results | help |
--code-completion-diagnostics | - Print compiler diagnostics while doing code completion | help |
--code-completion-keywords | - Include keywords in code completion results | help |
--code-completion-sourcetext | - Include source texts in code completion results | help |
--code-completion-token string | - Code completion token name | help |
--comments-xml-schema string | - Filename of the RelaxNG schema for documentation comments | help |
--completion-cache-path string | - Code completion cache path | help |
--completion-output-dir path | - Directory for completion output | help |
--conforming-methods-expected-types string | - Set expected types for comforming method list | help |
--cxx-interop-getters-setters-as-properties | - Imports getters and setters as computed properties. | help |
--debug-client-discriminator string | - A discriminator to prefer in lookups | help |
--debug-constraints | - Enable verbose debugging from the constraint solver. | help |
--debug-forbid-typecheck-prefix string | - Triggers llvm fatal_error if typechecker tries to typecheck a decl with the provided prefix name | help |
--decl-to-print string | - Decl name to print swift interface for | help |
--define-availability string | - Define a macro for @available | help |
--disable-access-control | - Disables access control, like a debugger | help |
--disable-objc-interop | - Disable ObjC interop. | help |
--enable-cross-import-overlays | - Automatically import declared cross-import overlays. | help |
--enable-deserialization-safety | - Avoid reading potentially unsafe decls from swiftmodules | help |
--enable-experimental-cxx-interop | - Enable C++ interop. | help |
--enable-experimental-feature string | - Enable an experimental feature | help |
--enable-objc-forward-declarations | - Import Objective-C forward declarations when possible | help |
--enable-objc-interop | - Enable ObjC interop. | help |
--enable-swift3-objc-inference | - Enable Swift 3's @objc inference rules | help |
--enable-swiftsourceinfo | - Whether to consume .swiftsourceinfo files | help |
--end-pos string | - Line:Column pair | help |
--explicit-swift-module-map-file string | - JSON file to include explicit Swift modules | help |
--explode-pattern-binding-decls | - Separate pattern binding decls into individual var decls | help |
--expressions | - Print expressions | help |
--filecheck path | - Path to 'FileCheck' utility | help |
--find-mangled string | - Print the entity with the given mangled name | help |
--fully-qualified-types | - Print fully qualified types | help |
--fully-qualified-types-if-ambiguous | - Print types fully-qualified if they would be ambiguous otherwise | help |
--function-definitions | - Print function bodies | help |
--header-to-print string | - Header filename to print swift interface for | help |
--iframework string | - add a directory to the system framework search path | help |
--import-objc-header string | - header to implicitly import | help |
--include-locals | - Index local symbols too. | help |
--load-plugin-executable string | - load plugin executable | help |
--load-plugin-library string | - load plugin library | help |
--module-alias string | - Use '-module-alias <name>=<binary_name>' to map a module of <name> that appears in source code to <binary_name> | help |
--module-cache-path string | - Clang module cache path | help |
--module-group string | - Name of the module group to print | help |
--module-name string | - The module name of the given test. | help |
--module-print-hidden | - Print non-exported imported or submodules | help |
--module-print-skip-overlay | - Skip Swift overlay modules | help |
--module-print-submodules | - Recursively print submodules | help |
--module-to-print string | - Name of the module to print | help |
--no-empty-line-between-members | - Print no empty line between members. | help |
--parse-as-library | - Parse '-source-filename' as a library source file | help |
--pch-output-dir string | - place autogenerated PCH files in this directory | help |
--playground | - Whether coloring in playground | help |
--plugin-path string | - plugin-path | help |
--pos string | - Line:Column pair | help |
--prefer-type-repr | - When printing types, prefer printing TypeReprs | help |
--print-access | - Print access keywords for all values | help |
--batch-code-completion | - Perform code completion in batch mode | help |
--code-completion | - Perform code completion | help |
--repl-code-completion | - Perform REPL-style code completion | help |
--dump-completion-cache | - Dump a code completion cache file | help |
--dump-importer-lookup-table | - Dump the Clang importer's lookup tables | help |
--syntax-coloring | - Perform syntax coloring | help |
--dump-comments | - Dump documentation comments attached to decls | help |
--structure | - Perform document structure annotation | help |
--annotate | - Perform semantic annotation | help |
--test-input-complete | - Check if input source is complete | help |
--print-ast-not-typechecked | - Print the non-typechecked AST | help |
--print-ast-typechecked | - Print the typechecked AST | help |
--print-module | - Print visible declarations in a module | help |
--print-module-metadata | - Print meta-data in a module | help |
--print-header | - Print visible declarations in a header file | help |
--print-swift-file-interface | - Print interface of a swift file | help |
--print-decl | - Print interface of a decl | help |
--print-types | - Print types of all subexpressions and declarations in the AST | help |
--print-comments | - Print documentation comments attached to decls | help |
--print-module-comments | - Given a module, print documentation comments attached to decls | help |
--print-module-imports | - Recursively print all imports visible from a particular module | help |
--print-usrs | - Print USRs for all decls | help |
--print-local-types | - Print local types and remanglings in a module | help |
--test-createCompilerInvocation | - Test swift::driver::createCompilerInvocation using the arguments passed to swift-ide-test (must be specified before all other arguments) | help |
--test-CompilerInvocation-from-module | - Test CompilerInvocation::loadFromSerializedAST on the "source" file | help |
--generate-module-api-description | - Generate a machine-readable description of module API | help |
--diff-module-api | - Compare machine-readable descriptions of module API | help |
--print-type-interface | - Print type-specific interface decl | help |
--reconstruct-type | - Reconstruct type from mangled name | help |
--print-module-groups | - Print group names in a module | help |
--range | - Print information about a given range | help |
--print-indexed-symbols | - Print indexed symbol information | help |
--type-context-info | - Perform expression context info analysis | help |
--print-expr-type | - Print types for all expressions in the file | help |
--conforming-methods | - Perform conforming method analysis for expression | help |
--print-implicit-attrs | - Print implicit attributes | help |
--print-interface | - Print with options set for interface printing, overrides any other printing option | help |
--print-interface-doc | - Print with options set for interface printing, for doc support; | help |
--print-original-source | - print the original source text for applicable declarations | help |
--print-regular-comments | - Print regular comments from clang module headers | help |
--print-stats | - Print statistics | help |
--random-seed seed | - Seed for the random number generator | help |
--resource-dir string | - The directory that holds the compiler resource files | help |
--sdk string | - path to the SDK to build against | help |
--second-source-filename string | - Name of the second source file | help |
--serialized-path-obfuscate string | - Path to access notes file | help |
--skip-deinit | - Whether to skip printing destructors | help |
--skip-filecheck | - Skip 'FileCheck' checking | help |
--skip-imports | - Whether to skip printing import declarations | help |
--skip-overrides | - Whether to skip printing overrides/witnesses | help |
--skip-parameter-names | - Whether to skip parameter names | help |
--skip-print-doc-comments | - Don't print documentation comments from clang module headers | help |
--skip-private-stdlib-decls | - Don't print declarations that start with '_' | help |
--skip-unavailable | - Don't print unavailable declarations | help |
--skip-underscored-stdlib-protocols | - Don't print protocols that start with '_' | help |
--skip-unsafe-cxx-methods | - Don't print unsafe C++ class methods that were renamed as unsafe | help |
--source-filename string | - Name of the source file | help |
--swift-version string | - Swift version | help |
--synthesize-extension | - Print synthesized extensions from conforming protocols. | help |
--synthesize-sugar-on-types | - Always print Array and Optional with sugar | help |
--target string | - target triple | help |
--terminal | - Use terminal color for source annotations | help |
--tools-directory string | - Path to external executables (ld, clang, binutils) | help |
--typecheck | - Type check the AST | help |
--usr string | - USR | help |
--usr-filter string | - Filter results by the given usrs | help |