| Name | sqlfluff-common-conventions JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A plugin for rules that enforce common SQL conventions not available in SQLFluff, compatible with BigQuery SQL. |
| upload_time | 2024-04-29 08:17:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Valerie Tan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sqlfluff
sql
linter
formatter
bigquery
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sqlfluff-common-conventions
A plugin for rules that enforce common SQL conventions not available in SQLFluff, compatible with BigQuery SQL.
## Rules
As of 25 April 2024, all rules are compatible with snake, dromedary, and pascal case.
- CC01: Start boolean columns with `is` or `has`.
- CC02: End datetime, time, and timestamp columns with `at`.
- CC03: End date columns with `date`.
- CC04: Only allow a list of configurable strings to be used in identifiers.
- CC05: Block a list of configurable strings from being used in identifiers.
Raw data
{
"_id": null,
"home_page": null,
"name": "sqlfluff-common-conventions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sqlfluff, sql, linter, formatter, bigquery",
"author": null,
"author_email": "Valerie Tan <valerietanhx@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/16/89/625eec98b5f4270939144ec29fd363f34ac80a13a3e16310ff37409fa211/sqlfluff_common_conventions-0.2.0.tar.gz",
"platform": null,
"description": "# sqlfluff-common-conventions\n\nA plugin for rules that enforce common SQL conventions not available in SQLFluff, compatible with BigQuery SQL.\n\n## Rules\n\nAs of 25 April 2024, all rules are compatible with snake, dromedary, and pascal case.\n\n- CC01: Start boolean columns with `is` or `has`.\n- CC02: End datetime, time, and timestamp columns with `at`.\n- CC03: End date columns with `date`.\n- CC04: Only allow a list of configurable strings to be used in identifiers.\n- CC05: Block a list of configurable strings from being used in identifiers.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Valerie Tan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A plugin for rules that enforce common SQL conventions not available in SQLFluff, compatible with BigQuery SQL.",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [
"sqlfluff",
" sql",
" linter",
" formatter",
" bigquery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01404e17e239f62d197da6d3a0cff7fe8fa1531548204d1b3870384bebdafdf9",
"md5": "c3193a9e9ffe693c29e1bf03274f3f99",
"sha256": "d7886cf72f190940b8dd801b7c312649bd32d3a2d4638331f7cd6c9fceb960f6"
},
"downloads": -1,
"filename": "sqlfluff_common_conventions-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3193a9e9ffe693c29e1bf03274f3f99",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10891,
"upload_time": "2024-04-29T08:17:43",
"upload_time_iso_8601": "2024-04-29T08:17:43.046645Z",
"url": "https://files.pythonhosted.org/packages/01/40/4e17e239f62d197da6d3a0cff7fe8fa1531548204d1b3870384bebdafdf9/sqlfluff_common_conventions-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1689625eec98b5f4270939144ec29fd363f34ac80a13a3e16310ff37409fa211",
"md5": "6797a660e306ee2e59bfc3ae3da770f2",
"sha256": "07c7037dcb3ca418837eaa32f63f97ec0226bc216fa6147378c3c464a440dfeb"
},
"downloads": -1,
"filename": "sqlfluff_common_conventions-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6797a660e306ee2e59bfc3ae3da770f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7502,
"upload_time": "2024-04-29T08:17:44",
"upload_time_iso_8601": "2024-04-29T08:17:44.346891Z",
"url": "https://files.pythonhosted.org/packages/16/89/625eec98b5f4270939144ec29fd363f34ac80a13a3e16310ff37409fa211/sqlfluff_common_conventions-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 08:17:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sqlfluff-common-conventions"
}
