# ninja-bear-language-shell
This [ninja-bear](https://pypi.org/project/ninja-bear) plugin adds support for Unix shell scripts. To use the constants in your code, use the *source*-command (e.g. source test_config.sh).
```yaml
languages:
# -------------------------------------------------------------------------
# Property description for ninja-bear-language-shell.
#
# language (required): ninja-bear-language-shell
# file_naming (optional): Specifies the file naming convention (snake |
# screaming-snake | camel | pascal | kebap).
# Defaults to the file-name without the extension.
# property_naming (optional): Specifies the property naming convention (snake |
# screaming-snake | camel | pascal | kebap).
# type_naming (optional): Specifies the naming convention for the generated
# type (snake | screaming-snake | camel | pascal |
# kebap). The default value is language specific.
# indent (optional): Specifies the amount of spaces before each
# property. Defaults to 4.
# transformers (optional): Specifies a list of transformers (alias) to use.
# distributors (optional): Specifies a list of distributors (alias) to use.
# ignore (optional): If true, the section gets ignored.
# -------------------------------------------------------------------------
- language: ninja-bear-language-shell
file_naming: snake
property_naming: screaming-snake
properties:
- type: bool
name: myBoolean
value: true
- type: int
name: myInteger
value: 142
- type: float
name: myFloat
value: 322f # Float with float specifier. However, an additional specifier (f) is not required and will be trimmed.
- type: float
name: myCombinedFloat
value: ${myInteger} * ${myFloat} # Number and boolean combinations get evaluated during the dump process.
- type: double
name: myDouble
value: 233.9
- type: string
name: myString
value: Hello World
hidden: true # If a property should act as a helper but should not be written to the generated file, it must be marked as 'hidden'.
- type: regex
name: myRegex
value: Test Reg(E|e)x
comment: Just another RegEx. # Variables can be described using the comment property.
- type: string
name: mySubstitutedString
value: Sometimes I just want to scream ${myString}! # To use the value of another property, simply use its name with ${}. E.g., ${myString}.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/monstermichl/ninja-bear-language-shell.git",
"name": "ninja-bear-language-shell",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ninja-bear, plugin, language, shell",
"author": "monstermichl",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/48/88/4e1ed0c5bcfd426ccb456fe50c13e533431f2fd3d16df4bc901413257aa2/ninja_bear_language_shell-0.1.0.tar.gz",
"platform": null,
"description": "# ninja-bear-language-shell\nThis [ninja-bear](https://pypi.org/project/ninja-bear) plugin adds support for Unix shell scripts. To use the constants in your code, use the *source*-command (e.g. source test_config.sh).\n\n```yaml\nlanguages:\n # -------------------------------------------------------------------------\n # Property description for ninja-bear-language-shell.\n #\n # language (required): ninja-bear-language-shell\n # file_naming (optional): Specifies the file naming convention (snake |\n # screaming-snake | camel | pascal | kebap).\n # Defaults to the file-name without the extension.\n # property_naming (optional): Specifies the property naming convention (snake |\n # screaming-snake | camel | pascal | kebap).\n # type_naming (optional): Specifies the naming convention for the generated\n # type (snake | screaming-snake | camel | pascal |\n # kebap). The default value is language specific.\n # indent (optional): Specifies the amount of spaces before each\n # property. Defaults to 4.\n # transformers (optional): Specifies a list of transformers (alias) to use.\n # distributors (optional): Specifies a list of distributors (alias) to use.\n # ignore (optional): If true, the section gets ignored.\n # -------------------------------------------------------------------------\n - language: ninja-bear-language-shell\n file_naming: snake\n property_naming: screaming-snake\n\nproperties:\n - type: bool\n name: myBoolean\n value: true\n\n - type: int\n name: myInteger\n value: 142\n\n - type: float\n name: myFloat\n value: 322f # Float with float specifier. However, an additional specifier (f) is not required and will be trimmed.\n\n - type: float\n name: myCombinedFloat\n value: ${myInteger} * ${myFloat} # Number and boolean combinations get evaluated during the dump process.\n\n - type: double\n name: myDouble\n value: 233.9\n\n - type: string\n name: myString\n value: Hello World\n hidden: true # If a property should act as a helper but should not be written to the generated file, it must be marked as 'hidden'.\n\n - type: regex\n name: myRegex\n value: Test Reg(E|e)x\n comment: Just another RegEx. # Variables can be described using the comment property.\n\n - type: string\n name: mySubstitutedString\n value: Sometimes I just want to scream ${myString}! # To use the value of another property, simply use its name with ${}. E.g., ${myString}.\n\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Shell language support for ninja-bear",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/monstermichl/ninja-bear-language-shell.git"
},
"split_keywords": [
"ninja-bear",
" plugin",
" language",
" shell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2c86001cefd5a8beea1c1d6386a872cf2e7d7b6f3530cc6a1daba4f0673fa14",
"md5": "df8635e594e14bb3f923a0a10a126132",
"sha256": "90a89ed83dd9a4248bd25adc7c65e5e8abf49e112fc6f1e850f1d3a290634316"
},
"downloads": -1,
"filename": "ninja_bear_language_shell-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df8635e594e14bb3f923a0a10a126132",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5548,
"upload_time": "2024-11-04T15:24:53",
"upload_time_iso_8601": "2024-11-04T15:24:53.171180Z",
"url": "https://files.pythonhosted.org/packages/e2/c8/6001cefd5a8beea1c1d6386a872cf2e7d7b6f3530cc6a1daba4f0673fa14/ninja_bear_language_shell-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "48884e1ed0c5bcfd426ccb456fe50c13e533431f2fd3d16df4bc901413257aa2",
"md5": "7f445525c645dc61feea4b0b2d8ded7b",
"sha256": "af6f8ff12b1685c343345d5e5a097d1a073f226e17545326fe834bde8fc4152c"
},
"downloads": -1,
"filename": "ninja_bear_language_shell-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7f445525c645dc61feea4b0b2d8ded7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5541,
"upload_time": "2024-11-04T15:24:54",
"upload_time_iso_8601": "2024-11-04T15:24:54.537990Z",
"url": "https://files.pythonhosted.org/packages/48/88/4e1ed0c5bcfd426ccb456fe50c13e533431f2fd3d16df4bc901413257aa2/ninja_bear_language_shell-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 15:24:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "monstermichl",
"github_project": "ninja-bear-language-shell",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ninja-bear-language-shell"
}
JSON
