Ksconf

~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix app deployment bug that can occur if a previously deployed path changes from a file to a directory.
* Internal layering improvements.
* Add/improve layer caching mechanisms.
Packaging large apps saw a 2-3x performance improvement during development.
* Add ability to filter layer operations base on based path names (not just layer names).
* Created concept of layer types, currently supporting implicit vs explicit layers.
* Cleanup some internally confusing terminology.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

More internal Laying improvements for the ansible collections (and general readability improvements).
No improvements for CLI users.

* Additional Layer handling improvements for AppPackager and LayerCombiner.
Primary benefits of these internal improvements are for the ``ksconf_package`` command in the `cdillc.splunk`_ collection, and anyone who has to look at the code.
* Replace all ``LayerRoot*`` terminology with ``LayerCollection`` to reduce confusion.
The term _root_ was used multiple places within the layering system to both a top-level folder, as well as a container of layers.
* Replace confusing nested ``Layer`` class structure for a more traditional flat one.
* Add a convenience function for LayerCollection creation (that handles various layering schemes).
* Add :py:method:~`ksconf.layer.LayerFilter.add_rules` to simplify frequent use case.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Update some app builder internal caching mechanisms that are now re-used by the ``ksconf_package`` command in the `cdillc.splunk`_ collection.
That's it. Everyone else can just skip this version.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add new ``--empty-stanza`` to :ref:`ksconf_cmd_filter`. Thanks to Manoj Baba for the idea.
* Fix ``unarchive`` bug when dealing with local files.
* Improve handling of UTF8-BOM in some situations. As always, the marker (BOM) will be silently discarded.


**API Changes**:

* Rename :py:func:`~ksconf.conf.parser.parse_string` to :py:func:`~ksconf.conf.parser.parse_conf_string` to keep names more consistent.
Starting in ksconf v0.15 using the old name will issue a deprecation warning.
Hopefully not many people are relying on this function yet, at it was only introduced 2 moths ago in v0.11.5.
This function will be removed in v0.20.0.
* Created new :py:func:`~ksconf.conf.parser.write_conf_string` function for writing a conf file to a python string.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix bug in `ksconf diff`` when using the ``--format=json`` option.
This has been broken for a number of releases (added a unit test to keep that from repeating).
Fixed the newly caused import issue caused by a missed file during the v0.13.4 release, as well as earlier Enum-related bug: ``TypeError: Object of type DiffVerb is not JSON serializable``.
* :py:class:`~ksconf.app.manifest.AppManifest`: Add ``filter_files()`` method for generic filtering capabilities, and ``drop_ds_autogen()`` to handle the specific use case of removing that "autogenerated" file created by Deployment Server.
* Linter and typing fixes

~~~~~~~~~~~~~~~~~~~~~~~~~~~

**API Changes (only)**:

* Minor tweaks to :py:mod:`ksconf.version` to use public names instead of dunder names.
So ``from ksconf.version import version`` instead of ``from ksconf.version import __version__``.
Note that the old names still exist, with no deprecation planned.
The api docs were updated to demo the best approach to determine the :ref:`ksconf version <api_ksconf_version>`
* Expand :py:class:`~ksconf.app.manifest.AppManifest` class to support file filtering upon manifest creation.
* Updated splunk app building example.