From f6a9c07f8f05706673e3e97291e72c8b886a0b16 Mon Sep 17 00:00:00 2001 From: danielpeintner Date: Thu, 13 Mar 2025 11:43:55 +0100 Subject: [PATCH 1/9] style: npm run format --- CODE_OF_CONDUCT.md | 20 +-- CONTRIBUTING.md | 104 +++++------ NOTICE.md | 2 +- README.md | 170 +++++++++--------- examples/quickstart/README.md | 6 +- examples/templates/exposed-thing/README.md | 114 ++++++------ packages/binding-coap/README.md | 4 +- packages/binding-file/README.md | 8 +- packages/binding-http/README.md | 14 +- packages/binding-mbus/README.md | 18 +- packages/binding-modbus/README.md | 46 ++--- packages/binding-modbus/src/modbus-client.ts | 8 +- packages/binding-mqtt/README.md | 14 +- packages/binding-netconf/README.md | 28 +-- packages/binding-opcua/README.md | 10 +- .../src/opcua-protocol-client.ts | 4 +- packages/browser-bundle/README.md | 2 +- packages/cli/README.md | 10 +- packages/core/README.md | 12 +- packages/core/src/codecs/octetstream-codec.ts | 20 +-- packages/examples/README.md | 8 +- packages/examples/src/quickstart/README.md | 6 +- packages/td-tools/README.md | 2 +- packages/td-tools/src/td-tools.ts | 11 +- 24 files changed, 321 insertions(+), 320 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c2135ea58..ae3201de3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -11,19 +11,19 @@ In the interest of fostering an open and welcoming environment, we as community Examples of behavior that contributes to creating a positive environment include: -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -- The use of sexualized language or imagery and unwelcome sexual attention or advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec856dc02..bbe947bcd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for your interest in this project. General information regarding source code management, builds, coding standards, and more can be found here: -- https://projects.eclipse.org/projects/iot.thingweb/developer +- https://projects.eclipse.org/projects/iot.thingweb/developer ## Legal Requirements @@ -13,22 +13,22 @@ This process helps us in creating great open source software within a safe legal Thus, before your contribution can be accepted by the project team, contributors must electronically sign the [Eclipse Contributor Agreement (ECA)](http://www.eclipse.org/legal/ECA.php) and follow these preliminary steps: -- Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/) - - Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those - - Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user) -- Add your GiHub username to your Eclipse Foundation account - - ([Log into Eclipse](https://accounts.eclipse.org/)) - - Go to the _Edit Profile_ tab - - Fill in the _GitHub ID_ under _Social Media Links_ and save -- Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php) - - ([Log into Eclipse](https://accounts.eclipse.org/)) - - If the _Status_ entry _Eclipse Contributor Agreement_ has a green checkmark, the ECA is already signed - - If not, go to the _Eclipse Contributor Agreement_ tab or follow the corresponding link under _Status_ - - Fill out the form and sign it electronically -- Sign-off every commit using the same email address used for your Eclipse account - - Set the Git user email address with `git config user.email ""` - - Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"` -- Open a [Pull Request](https://github.com/eclipse-thingweb/node-wot/pulls) +- Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/) + - Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those + - Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user) +- Add your GiHub username to your Eclipse Foundation account + - ([Log into Eclipse](https://accounts.eclipse.org/)) + - Go to the _Edit Profile_ tab + - Fill in the _GitHub ID_ under _Social Media Links_ and save +- Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php) + - ([Log into Eclipse](https://accounts.eclipse.org/)) + - If the _Status_ entry _Eclipse Contributor Agreement_ has a green checkmark, the ECA is already signed + - If not, go to the _Eclipse Contributor Agreement_ tab or follow the corresponding link under _Status_ + - Fill out the form and sign it electronically +- Sign-off every commit using the same email address used for your Eclipse account + - Set the Git user email address with `git config user.email ""` + - Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"` +- Open a [Pull Request](https://github.com/eclipse-thingweb/node-wot/pulls) For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit @@ -100,20 +100,20 @@ To reduce the size of the installation from about 800 MByte down to about 200 MB #### Troubleshooting -- Build error about `No matching version found for @node-wot/...` or something about `match` - - try `npm run unlock` from the project root before building -- `sudo npm run link` does not work - - try `npm run unlock` from the project root before calling `[sudo] npm run link` - - try `npm link` in each package directory in this order: td-tools, core, binding-\*, cli, demo-servients -- Error mesage for `npm link @node-wot/` - `ELOOP: too many symbolic links encountered, stat '/usr/lib/node_modules/@node-wot/` +- Build error about `No matching version found for @node-wot/...` or something about `match` + - try `npm run unlock` from the project root before building +- `sudo npm run link` does not work + - try `npm run unlock` from the project root before calling `[sudo] npm run link` + - try `npm link` in each package directory in this order: td-tools, core, binding-\*, cli, demo-servients +- Error mesage for `npm link @node-wot/` + `ELOOP: too many symbolic links encountered, stat '/usr/lib/node_modules/@node-wot/` 1. Run `npm run link` in `thingweb.node-wot` again 2. Remove `node_modules` in the targeted project 3. Remove all `@node-wot/` dependencies in your `package.json` 4. Run `npm i` again 5. Install the packages with `npm link @node-wot/` -- Build error around `prebuild: npm run bootstrap` - - This has been seen failing on WSL. Try using a more recent Node.js version +- Build error around `prebuild: npm run bootstrap` + - This has been seen failing on WSL. Try using a more recent Node.js version ## Adding a New Protocol Binding @@ -205,28 +205,28 @@ Commit messages must be structured as follows: