{"id":13600825,"url":"https://github.com/yaegassy/coc-sqlfluff","last_synced_at":"2025-03-09T09:30:48.709Z","repository":{"id":43022094,"uuid":"366214431","full_name":"yaegassy/coc-sqlfluff","owner":"yaegassy","description":"SQLFluff (A SQL linter and auto-formatter for Humans) extension for coc.nvim","archived":false,"fork":false,"pushed_at":"2023-05-16T06:50:32.000Z","size":394,"stargazers_count":29,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-07T00:37:33.635Z","etag":null,"topics":["coc","coc-extensions","coc-nvim","formatter","linter","neovim","sql","vim"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/coc-sqlfluff","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yaegassy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-05-11T00:49:48.000Z","updated_at":"2025-02-08T22:22:41.000Z","dependencies_parsed_at":"2024-01-16T23:26:15.263Z","dependency_job_id":"ad196b9d-a64b-47b7-8ec4-59e33e400049","html_url":"https://github.com/yaegassy/coc-sqlfluff","commit_stats":{"total_commits":186,"total_committers":3,"mean_commits":62.0,"dds":"0.010752688172043001","last_synced_commit":"da9e072b2c97e46cdf5bf195cba4384885606dbb"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-sqlfluff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-sqlfluff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-sqlfluff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-sqlfluff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yaegassy","download_url":"https://codeload.github.com/yaegassy/coc-sqlfluff/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242309918,"owners_count":20106737,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coc","coc-extensions","coc-nvim","formatter","linter","neovim","sql","vim"],"created_at":"2024-08-01T18:00:49.419Z","updated_at":"2025-03-09T09:30:48.368Z","avatar_url":"https://github.com/yaegassy.png","language":"TypeScript","funding_links":[],"categories":["Language Support"],"sub_categories":[],"readme":"# coc-sqlfluff\n\n[SQLFluff](https://pypi.org/project/sqlfluff/) (A SQL linter and auto-formatter for Humans) extension for [coc.nvim](https://github.com/neoclide/coc.nvim)\n\n\u003cimg width=\"780\" alt=\"coc-sqlfluff-demo\" src=\"https://user-images.githubusercontent.com/188642/117741969-a6bc3200-b23e-11eb-9481-83e6fe71ee3d.gif\"\u003e\n\n## Features\n\n- Lint\n- Format\n- Code Action\n- Built-in installer\n\n## Install\n\n**CocInstall**:\n\n```vim\n:CocInstall coc-sqlfluff\n```\n\n**vim-plug**:\n\n```vim\nPlug 'yaegassy/coc-sqlfluff', {'do': 'yarn install --frozen-lockfile'}\n```\n\n## Detect: sqlfluff\n\n1. `sqlfluff.commandPath` setting\n1. PATH environment (e.g. system global PATH or venv, etc ...)\n1. builtin: extension-only \"venv\" (Installation commands are also provided)\n\n## Bult-in install\n\ncoc-sqlfluff allows you to create an extension-only \"venv\" and install \"sqlfluff\".\n\nThe first time you use coc-sqlfluff, if sqlfluff is not detected, you will be prompted to do a built-in installation.\n\nYou can also run the installation command manually.\n\n```vim\n:CocCommand sqlfluff.install\n```\n\n## SQLFluff configuration file (setup.cfg, tox.ini, pep8.ini, .sqlfluff, pyproject.toml)\n\nSQLFluff is able to read project-specific default values for its command line options, or from a configuration file.\n\nSQLFluff will look for the following files in order. Later files will (if found) will be used to overwrite any vales read from earlier files.\n\n1. `setup.cfg`\n1. `tox.ini`\n1. `pep8.ini`\n1. `.sqlfluff`\n1. `pyproject.toml`\n\n**REF**:\n\n- \u003chttps://docs.sqlfluff.com/en/stable/configuration.html\u003e\n\n## Configuration options\n\n- `sqlfluff.enable`: Enable coc-sqlfluff extension, default: `true`\n- `sqlfluff.commandPath`: The path to the sqlfluff command (Absolute path), default: `\"\"`\n- `sqlfluff.builtin.pythonPath`: Python 3.x path (Absolute path) to be used for built-in install, default: `\"\"`\n- `sqlfluff.dialect`: The dialect of SQL to lint, valid option: `[\"ansi\", \"bigquery\", \"clickhouse\", \"databricks\", \"db2\", \"duckdb\", \"exasol\", \"hive\", \"mysql\", \"oracle\", \"postgres\", \"redshift\", \"snowflake\", \"soql\", \"sparksql\", \"sqlite\", \"teradata\", \"tsql\"]`, default: `\"ansi\"`\n- `sqlfluff.linter.ignoreParsing`: Whether the sql linter should ignore parsing errors, default: `true`\n- `sqlfluff.lintOnOpen`: Lint file on opening, default: `true`\n- `sqlfluff.lintOnChange`: Lint file on change, default: `true`\n- `sqlfluff.lintOnSave`: Lint file on save, default: `true`\n- `sqlfluff.formatEnable`: Whether the document formatter is enabled or not, default: `true`\n- `sqlfluff.formatIgnoreStderrAlert`: Ignore stderr message output when formatting is executed, e.g. `Unfixable violations detected`, default: `true`\n\n## Commands\n\n- `sqlfluff.install`: Install sqlfluff\n  - It will be installed in this path:\n    - Mac/Linux: `~/.config/coc/extensions/coc-sqlfluff-data/sqlfluff/venv/bin/sqlfluff`\n    - Windows: `~/AppData/Local/coc/extensions/coc-sqlfluff-data/sqlfluff/venv/Scripts/sqlfluff.exe`\n- `sqlfluff.fix`: Run sqlfluff fix file\n- `sqlfluff.format`: Run sqlfluff format file (Available in sqlfluff `v2.0.0` and later)\n- `sqlfluff.showOutput`: Show sqlfluff output channel\n\n## Code Actions\n\n**Example key mapping (Code Action related)**:\n\n```vim\nnmap \u003csilent\u003e ga \u003cPlug\u003e(coc-codeaction-line)\n```\n\n**Usage**:\n\nIn the line with diagnostic message, enter the mapped key (e.g. `ga`) and you will see a list of code actions that can be performed.\n\n**Actions**:\n\n- `Ignoring Errors for current line (-- noqa)`\n- `Ignoring Errors for current line (-- noqa: disable=all)`\n- `Ignoring Errors for current line (-- noqa: enable=all)`\n- `Show web documentation for {RULE_ID}`\n\n## Thanks\n\n- [sqlfluff/sqlfluff](https://github.com/sqlfluff/sqlfluff)\n\n## License\n\nMIT\n\n---\n\n\u003e This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyaegassy%2Fcoc-sqlfluff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyaegassy%2Fcoc-sqlfluff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyaegassy%2Fcoc-sqlfluff/lists"}