https://github.com/saltstack-formulas/jetbrains-webstorm-formula
Saltstack formula for Jetbrains WebStorm JavaScript IDE (standard edition)
https://github.com/saltstack-formulas/jetbrains-webstorm-formula
jetbrains-ides salt-formula saltstack-formula webstorm
Last synced: 9 months ago
JSON representation
Saltstack formula for Jetbrains WebStorm JavaScript IDE (standard edition)
- Host: GitHub
- URL: https://github.com/saltstack-formulas/jetbrains-webstorm-formula
- Owner: saltstack-formulas
- License: other
- Created: 2018-02-03T13:35:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T20:01:35.000Z (about 1 year ago)
- Last Synced: 2025-05-02T09:48:44.641Z (about 1 year ago)
- Topics: jetbrains-ides, salt-formula, saltstack-formula, webstorm
- Language: SaltStack
- Homepage:
- Size: 256 KB
- Stars: 1
- Watchers: 30
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
webstorm-formula
================
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/webstorm-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/webstorm-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/semantic-release
Formula to install Webstorm on Windows, GNU/Linux and MacOS.
.. contents:: **Table of Contents**
:depth: 1
General notes
-------------
See the full `SaltStack Formulas installation and usage instructions
`_.
If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
`_.
If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
which contains the currently released version. This formula is versioned according to `Semantic Versioning `_.
See `Formula Versioning Section `_ for more details.
If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.
Contributing to this repo
-------------------------
**Commit message formatting is significant!!**
Please see `How to contribute `_ for more details.
Special notes
-------------
None.
Available states
----------------
.. contents::
:local:
``webstorm``
^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
This installs Webstorm package,
manages Webstorm configuration file and then
configures the development environment.
``webstorm.archive``
^^^^^^^^^^^^^^^^^^^^
This state will install Webstorm from archive only.
``webstorm.macapp``
^^^^^^^^^^^^^^^^^^^
This state will install Webstorm from source only.
``webstorm.config``
^^^^^^^^^^^^^^^^^^^
This state will configure npmrc and/or environment and has a dependency on ``webstorm.install``
via include list.
``webstorm.linuxenv``
^^^^^^^^^^^^^^^^^^^^^
This state will install some Webstorm linux-alternatives on GNU/Linux.
``webstorm.clean``
^^^^^^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
this state will undo everything performed in the ``webstorm`` meta-state in reverse order, i.e.
removes the configuration file and
then uninstalls the package.
``webstorm.config.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove the configuration of Webstorm and has a
dependency on ``webstorm.package.clean`` via include list.
``webstorm.archive.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove Webstorm package and has a dependency on
``webstorm.config.clean`` via include list.
``webstorm.macapp.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove Webstorm package and has a dependency on
``webstorm.config.clean`` via include list.
``webstorm.linuxenv.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove Webstorm linux-alternatives on GNU/Linux.
Testing
-------
Linux testing is done with ``kitchen-salt``.
Requirements
^^^^^^^^^^^^
* Ruby
* Docker
.. code-block:: bash
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``debian-9-2019-2-py3``.
``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^
Creates the docker instance and runs the ``webstorm`` main state, ready for testing.
``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^
Runs the ``inspec`` tests on the actual instance.
``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^^^^^
Removes the docker instance.
``bin/kitchen test``
^^^^^^^^^^^^^^^^^^^^
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^
Gives you SSH access to the instance for manual testing.