Documentation
¶
Overview ¶
Package sync defines constants for the ctx sync command, including config file detection patterns.
Index ¶
Constants ¶
View Source
const ( PatternEslint = ".eslintrc*" PatternPrettier = ".prettierrc*" PatternTSConfig = "tsconfig.json" PatternEditorConf = ".editorconfig" PatternMakefile = "Makefile" PatternDockerfile = "Dockerfile" )
Config file glob patterns checked by ctx sync.
View Source
const ( ActionDeps = "DEPS" ActionConfig = "CONFIG" ActionNewDir = "NEW_DIR" )
Action type constants for sync check results.
View Source
const KeywordDependencies = "dependencies"
KeywordDependencies is the search keyword for dependency documentation.
Variables ¶
View Source
var ImportantDirs = map[string]bool{ "api": true, "app": true, "cmd": true, "components": true, "internal": true, "lib": true, "pkg": true, "services": true, "src": true, "web": true, }
ImportantDirs lists top-level directories that should be documented in ARCHITECTURE.md.
View Source
var SkipDirs = map[string]bool{ "build": true, "dist": true, "node_modules": true, "vendor": true, }
SkipDirs lists directories excluded from sync directory scanning.
Functions ¶
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.