@sdeverywhere/plugin-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+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.

package/README.md

@@ -0,0 +1,60 @@
+# @sdeverywhere/plugin-config
+
+This package provides a plugin that reads CSV files used to configure a library or app
+around an SDEverywhere-generated system dynamics model.
+
+## Install
+
+```sh
+# npm
+npm install --save-dev @sdeverywhere/plugin-config
+
+# pnpm
+pnpm add -D @sdeverywhere/plugin-config
+
+# yarn
+yarn add -D @sdeverywhere/plugin-config
+```
+
+## Usage
+
+To get started:
+
+1. Copy the included template config files to your local project:
+
+```sh
+cd your-model-project
+npm install --save-dev @sdeverywhere/plugin-config
+cp -rf "./node_modules/@sdeverywhere/plugin-config/template-config" ./config
+```
+
+2. Replace the placeholder values in the CSV files with values that are suitable for your model.
+
+3. Add a line to your `sde.config.js` file that uses the `configProcessor` function supplied by this package:
+
+```js
+import { configProcessor } from '@sdeverywhere/plugin-config'
+
+export async function config() {
+  return {
+    // Specify the Vensim model to read
+    modelFiles: ['sample.mdl'],
+
+    // Read csv files from `config` directory and write to the `generated` directory
+    modelSpec: configProcessor({
+      config: configDir,
+      out: genDir
+    }),
+
+    plugins: [
+      // ...
+    ]
+  }
+}
+```
+
+4. Run `sde bundle` or `sde dev`; your config files will be used to drive the build process.
+
+## License
+
+SDEverywhere is distributed under the MIT license. See `LICENSE` for more details.