Refactor/extract openscd dependencies #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

trusz merged 28 commits into com-pas:main from philippilievskibearingpointcom:refactor/extract-openscd-dependencies

May 2, 2025

.github/workflows/publish.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -17,80 +17,60 @@ permissions:
  
    jobs:

      build:

        runs-on: ubuntu-latest

        outputs:

          artifact-name: ${{ steps.upload.outputs.artifact-name }}

        steps:

          - name: Checkout Repository (with Submodules)

          - name: Checkout main branch

            uses: actions/checkout@v4

            with:

              submodules: recursive

          - name: Use Node.js 18.x

            uses: actions/setup-node@v4

            with:

              node-version: 18

          - name: Install dependencies

            run: npm ci

          - name: Cache Main Project Dependencies

            uses: actions/cache@v4

            id: main-cache

            with:

              path: node_modules

              key: ${{ runner.os }}-main-node-${{ hashFiles('package-lock.json') }}

              restore-keys: |

                ${{ runner.os }}-main-node-

          - name: Install Dependencies

            if: steps.main-cache.outputs.cache-hit != 'true'

            run: npm install

          - name: Cache Submodule Dependencies

            uses: actions/cache@v4

            id: submodule-cache

            with:

              path: openscd/node_modules

              key: ${{ runner.os }}-submodule-node-${{ hashFiles('openscd/package-lock.json') }}

              restore-keys: |

                ${{ runner.os }}-submodule-node-

          - name: Install Submodule Dependencies

            if: steps.submodule-cache.outputs.cache-hit != 'true'

            run: npm install

            working-directory: openscd

          - name: Build Submodule

            run: npm run build

            working-directory: openscd

          - name: Build plugins

            run: npm run build:plugins

          - name: Build Project

            run: npm run build

          - name: Upload Build Artifact

            id: upload

          - name: Upload artifact

            uses: actions/upload-artifact@v4

            with:

              name: dist

              path: dist

              name: plugins-dist

              path: dist/

      deploy:

        needs: build

        if: github.ref == 'refs/heads/main' && github.event_name == 'push'

        runs-on: ubuntu-latest

        if: |

          github.ref == 'refs/heads/main' &&

          (github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true))

        steps:

          - name: Checkout Repository

          - name: Checkout gh-pages branch

            uses: actions/checkout@v4

            with:

              ref: gh-pages

          - name: Download Build Artifact

          - name: Clean gh-pages branch

            run: |

              git rm -rf .

              git clean -fxd

          - name: Download build artifact

            uses: actions/download-artifact@v4

            with:

              name: dist

              path: dist

          - name: Deploy to GitHub Pages

            uses: JamesIves/github-pages-deploy-action@v4

            with:

              folder: dist

              branch: gh-pages

              target-folder: plugins

              name: plugins-dist

              path: ./dist

          - name: Copy plugins to gh-pages

            run: |

              mkdir -p plugins

              cp -r dist/* plugins/

          - name: Commit and push changes

            run: |

              git config user.name 'github-actions[bot]'

              git config user.email 'github-actions[bot]@users.noreply.github.com'

              git add plugins

              git commit -m "Deploy latest plugins build" || echo "No changes to commit"

              git push origin gh-pages

apps/plugins/.nojekyll

This file was deleted.

apps/plugins/snowpack.config.mjs

This file was deleted.

apps/plugins/src/editors/Cleanup.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,8 @@ import './cleanup/datasets-container.js'; @@
     import './cleanup/control-blocks-container.js';
     import './cleanup/datatypes-container.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for cleaning SCL references and definitions. */
     export default class Cleanup extends LitElement {
       /** The document being edited as provided to plugins by [[`OpenSCD`]]. */
@@ Expand Down @@

apps/plugins/src/editors/Communication.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,8 @@ import { createElement } from '@openscd/xml'; @@
     import { newActionEvent } from '@openscd/core/foundation/deprecated/editor.js';
     import { createSubNetworkWizard } from '../wizards/subnetwork.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for editing the `Communication` section. */
     export default class CommunicationPlugin extends LitElement {
       /** The document being edited as provided to plugins by [[`OpenSCD`]]. */
@@ Expand Down @@

apps/plugins/src/editors/GooseSubscriberDataBinding.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import './subscription/fcda-binding-list.js';
     import './subscription/later-binding/ext-ref-ln-binding-list.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for Subscribe Data Binding (GOOSE). */
     export default class GooseSubscribeDataBindingPlugin extends LitElement {
       @property({ attribute: false })
@@ Expand Down @@

apps/plugins/src/editors/GooseSubscriberLaterBinding.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import './subscription/fcda-binding-list.js';
     import './subscription/later-binding/ext-ref-later-binding-list.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for Subscribe Later Binding (GOOSE). */
     export default class GooseSubscribeLaterBindingPlugin extends LitElement {
       @property({ attribute: false })
@@ Expand Down @@

apps/plugins/src/editors/GooseSubscriberMessageBinding.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,8 @@ import './subscription/goose/goose-list.js'; @@
     import './subscription/ied-list.js';
     import { newViewEvent, View, ViewEvent } from './subscription/foundation.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** Defining view outside the class, which makes it persistent. */
     let view: View = View.PUBLISHER;
@@ Expand Down @@

apps/plugins/src/editors/IED.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -27,6 +27,8 @@ import { @@
     import { Nsdoc } from '@openscd/open-scd/src/foundation/nsdoc.js';
     import { getIcon } from '@openscd/open-scd/src/icons/icons.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for editing the `IED` section. */
     export default class IedPlugin extends LitElement {
       /** The document being edited as provided to plugins by [[`OpenSCD`]]. */
@@ Expand Down @@

apps/plugins/src/editors/Protocol104.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import './protocol104/network-container.js';
     import './protocol104/values-container.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     import {
       newViewEvent,
       View,
@@ Expand Down @@

apps/plugins/src/editors/Publisher.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,8 @@ import './publisher/gse-control-editor.js'; @@
     import './publisher/sampled-value-control-editor.js';
     import './publisher/data-set-editor.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] to configure `Report`, `GOOSE`, `SampledValue` control blocks and its `DataSet` */
     export default class PublisherPlugin extends LitElement {
       /** The document being edited as provided to plugins by [[`OpenSCD`]]. */
@@ Expand Down @@

apps/plugins/src/editors/SMVSubscriberDataBinding.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import './subscription/fcda-binding-list.js';
     import './subscription/later-binding/ext-ref-ln-binding-list.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for Subscribe Data Binding (SMV). */
     export default class SMVSubscribeDataBindingPlugin extends LitElement {
       @property({ attribute: false })
@@ Expand Down @@

apps/plugins/src/editors/SMVSubscriberLaterBinding.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import './subscription/fcda-binding-list.js';
     import './subscription/later-binding/ext-ref-later-binding-list.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** An editor [[`plugin`]] for Subscribe Later Binding (SMV). */
     export default class SMVSubscribeLaterBindingPlugin extends LitElement {
       @property({ attribute: false })
@@ Expand Down @@

apps/plugins/src/editors/SMVSubscriberMessageBinding.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,8 @@ import './subscription/sampledvalues/smv-list.js'; @@
     import './subscription/ied-list.js';
     import { newViewEvent, View, ViewEvent } from './subscription/foundation.js';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /** Defining view outside the class, which makes it persistent. */
     let view: View = View.PUBLISHER;
@@ Expand Down @@

apps/plugins/src/editors/SingleLineDiagram.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -53,6 +53,8 @@ import '@material/mwc-list/mwc-list-item'; @@
     import '@material/mwc-select';
     import '@material/mwc-textfield';
+    import '@openscd/open-scd/src/translations/i18n-config';
     /*
      * We need a variable outside the plugin to save the selected substation, because the Plugin is created
      * more than once during working with the SLD, for instance when opening a Wizard to edit equipment.
@@ Expand Down @@

apps/plugins/src/editors/Substation.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -7,6 +7,8 @@ import './substation/zeroline-pane.js';
  
    import { newWizardEvent } from '@openscd/open-scd/src/foundation.js';

    import { wizards } from '../wizards/wizard-library.js';

    import '@openscd/open-scd/src/translations/i18n-config';

    /** An editor [[`plugin`]] for editing the `Substation` section. */

    export default class SubstationPlugin extends LitElement {

      /** The document being edited as provided to plugins by [[`OpenSCD`]]. */

    @@ -25,18 +27,18 @@ export default class SubstationPlugin extends LitElement {
  
        return html` <zeroline-pane

            .editCount=${this.editCount}

            .doc=${this.doc}

          ></zeroline-pane>

          ${!this.doc?.querySelector(

        ></zeroline-pane>

        ${!this.doc?.querySelector(

            ':root > Substation, :root > Line, :root > Process'

          )

        )

            ? html`<h1>

                <mwc-fab

              <mwc-fab

                  extended

                  icon="add"

                  label="${get('substation.wizard.title.add')}"

                  @click=${() => this.openCreateSubstationWizard()}

                ></mwc-fab>

              </h1>`

              ></mwc-fab>

            </h1>`

            : html``}`;

      }

apps/plugins/src/editors/Templates.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -40,6 +40,8 @@ import { List } from '@material/mwc-list'; @@
     import { ListItem } from '@material/mwc-list/mwc-list-item';
     import { SingleSelectedEvent } from '@material/mwc-list/mwc-list-foundation';
+    import '@openscd/open-scd/src/translations/i18n-config';
     const templates = fetch('public/xml/templates.scd')
       .then(response => response.text())
       .then(str => new DOMParser().parseFromString(str, 'application/xml'));
@@ Expand Down @@

apps/plugins/src/wizards/substation.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -17,10 +17,12 @@ import {
  
    import { guessVoltageLevel } from '../editors/substation/guess-wizard.js';

    import { updateNamingAttributeWithReferencesAction } from './foundation/actions.js';

    import '@openscd/open-scd/src/translations/i18n-config';

    function render(

      name: string,

      desc: string | null,

      guessable: boolean

        name: string,

        desc: string | null,

        guessable: boolean

    ): TemplateResult[] {

      return [

        html`<wizard-textfield

    @@ -38,10 +40,10 @@ function render(
  
          helper="${get('substation.wizard.descHelper')}"

        ></wizard-textfield>`,

        guessable

          ? html`<mwc-formfield label="${get('guess.wizard.primary')}">

            ? html`<mwc-formfield label="${get('guess.wizard.primary')}">

              <mwc-checkbox></mwc-checkbox>

            </mwc-formfield>`

          : html``,

            : html``,

      ];

    }

    @@ -65,8 +67,8 @@ export function createAction(parent: Element): WizardActor {
  
    export function createSubstationWizard(parent: Element): Wizard {

      const guessable =

        parent.ownerDocument.querySelector('Substation') === null &&

        parent.tagName === 'SCL';

          parent.ownerDocument.querySelector('Substation') === null &&

          parent.tagName === 'SCL';

      return [

        {

    @@ -91,14 +93,14 @@ export function substationEditWizard(element: Element): Wizard {
  
            icon: 'edit',

            label: get('save'),

            action: updateNamingAttributeWithReferencesAction(

              element,

              'substation.action.updatesubstation'

                element,

                'substation.action.updatesubstation'

            ),

          },

          content: render(

            element.getAttribute('name') ?? '',

            element.getAttribute('desc'),

            false

              element.getAttribute('name') ?? '',

              element.getAttribute('desc'),

              false

          ),

        },

      ];

apps/plugins/tsconfig.json

-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
     {
+      "extends": "../../tsconfig.base.json",
       "compilerOptions": {
         "target": "es2020",
         "module": "esnext",
@@ Expand All / @@ -16,7 +17,12 @@ @@
         "sourceMap": true,
         "inlineSources": true,
         "resolveJsonModule": true,
-        "rootDir": "./src"
+        "rootDir": "../../",
       },
-      "include": ["src/**/*.ts"]
+      "include": [
+        "./src/**/*.ts",
+        "../../libs/openscd/open-scd/src/**/*.ts",
+        "../../libs/openscd/core/src/**/*.ts",
+        "../../libs/openscd/xml/src/**/*.ts"
+      ]
     }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/extract openscd dependencies #5

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!