Feature/initial setup

.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true

.github/dependabot.yaml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: daily

.github/workflows/check-dist.yaml

@@ -0,0 +1,42 @@
+name: Check dist/
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+  merge_group:
+
+jobs:
+  check-dist:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Rebuild the dist/ directory
+        run: |
+          npm run build
+
+      - name: Compare the expected and actual dist/ directories
+        run: |
+          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build. See status below:"
+            git diff
+            exit 1
+          fi

.github/workflows/publish.yaml

@@ -0,0 +1,32 @@
+name: Publish package to GitHub Packages
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js and set registry to GitHub Packages
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish package to GitHub Packages
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+.idea
+node_modules

.npmignore

@@ -0,0 +1,6 @@
+.github
+.gitattributes
+.nvmrc
+.prettierignore
+.prettierrc.json
+tsconfig.json

.nvmrc

@@ -0,0 +1 @@
+lts/iron

.prettierignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid"
+}

README.md

@@ -1 +1,83 @@
-# stencil-styleguide-output-target
+# @netlogix/stencil-styleguide-output-target
+
+A stencil output target which also builds Pattern Lab and processes scss
+
+## Usage
+
+To use this output target, add it to your `stencil.config.ts`:
+
+```typescript  
+import { Config } from '@stencil/core';
+import { sass } from '@stencil/sass';
+import { patternLabOutputTarget } from "@netlogix/stencil-styleguide-output-target";
+import postcss from "rollup-plugin-postcss";
+
+export const config: Config = {
+    namespace: 'stencil',
+    srcDir: 'source/script',
+    watchIgnoredRegex: /dependencyGraph.json/, // important for watching for changes in patternlab
+    outputTargets: [
+         // ... other output targets
+         patternLabOutputTarget({
+             rollupOptions:
+                 {
+                     input: 'source/css/style.scss',
+                     plugins: [
+                         postcss({
+                             modules: true,
+                             extract: true,
+                         }),
+                     ],
+                 },
+         }),
+         // ...
+    ],
+    devServer: {
+        openBrowser: false,
+        reloadStrategy: "pageReload", // important for hot reload to work with patternlab
+        root: 'public',
+    },
+    plugins: [
+        sass(),
+    ],
+    // ...
+};
+```
+## Configuration
+The PatternlabOutput function takes an optional configuration object with the following properties:
+
+`rollupOptions`:
+
+An object with rollup options to be merged with the default options.
+
+Default:
+```
+rollupOptions: {
+      input: 'source/scss/style.scss',
+      plugins: [
+        postcss({
+          modules: true,
+          extract: true
+        })
+      ]
+    },
+```
+#
+`rollupOutputOptions`:
+
+An object with rollup output options to be merged with the default options.
+
+Default:
+```
+rollupOutputOptions: {
+      name: 'style',
+      dir: './public/css',
+      format: 'es'
+},
+```
+#
+`sourceDir`: the directory which will be watched. Default: `source/**/*`
+
+
+## License
+This package is licensed under the MIT license.