opent2t-translator-com-wink-lightbulb
npm i opent2t-translator-com-wink-lightbulb

opent2t-translator-com-wink-lightbulb

Repository for Open Translators to Things.

by openT2T

1.4.2 (see all)License:MITTypeScript:Not Found
npm i opent2t-translator-com-wink-lightbulb
Readme

Introduction

Repository for Open Translators to Things. Grouped by translators written for specific schemas. The schema names are uniquely namespaced. The translator name is a unique string identifying a Thing.

This README will help get you started developing in this repo.

Install Tools

Get your dev environment set up (PC or Mac):

Get the Source

Next, clone this repo to your local machine to get started. Navigate to the directory where you want to clone the repo to locally, then run:

git clone https://github.com/openT2T/translators.git

Create a New Translator

Follow our getting started guide at http://www.opentranslatorstothings.org. Note that we have some required naming rules for translator node packages:

  1. The npm package names must always have "opent2t-translator-" prefix. We are not currently using npm namespacing.
  2. After the prefix, we will kebab-case the reverse-URI that is translator name, so e.g. "com.wink.lightbulb" becomes "opent2t-translator-com-wink-lightbulb".

Here is some background reading for those who are curious:

  1. Node package name requirements/rules: https://docs.npmjs.com/files/package.json.
  2. Issue #50 includes a discussion and some context behind this naming guidance.

Run Integration Tests

  1. Install gulp globally.
npm install -g gulp
  1. Install dependencies.
npm install verifiers
  1. Run integration tests.
gulp ci-checks

Notes:

  1. Other gulp tasks can be run as well, see gulpfile.js for available tasks.
  2. By default all files under the translators repo will be tested.
  3. Use the --cwd option to only test files under a specified directory:
gulp --cwd .\org.opent2t.sample.windowshade.superpopular\ ci-checks

Create a Pull Request

Made any changes we should consider? Send us a pull request! Check out this article on how to get started.

Publish a Translator Package to NPM

A translator package includes one thing translator along with all the schemas it references. Because those are not organized in the way npm publish expects, the process of publishing a translator package uses a script from the CLI repo.

  1. Update the version property in the package.json file in the translator directory. (Of cource any other metadata may be updated also, but a version bump is required when publishing to npm, since you may not re-publish over an existing version.)

  2. Clone the CLI repo (or sync it as needed), and install its dependencies:

cd ..
git clone https://github.com/opent2t-cli
npm install
cd ../translators
  1. Use the script to generate a package.json for the translator to be published. Note the last parameter is a simple name of a translator, not a directory path, which would include a schema name.
node ../opent2t-cli/pack-translator.js com.wink.thermostat
  1. Edit the package.json to include directories for referenced schemas in the files collection at the end. Lines will include at least "oic.core" and "oic.baseresource"; possibly others if the OCF schema .json file has $ref references to others. (Eventually the pack-translator.js script should add these lines automatically.)

  2. Ensure you're logged in to NPM under the opent2t account:

npm login
Username: opent2t
Password: *********
  1. Publish the package to NPM:
npm publish

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Downloads/wk

1

GitHub Stars

29

LAST COMMIT

5yrs ago

MAINTAINERS

1

CONTRIBUTORS

36

OPEN ISSUES

29

OPEN PRs

2
VersionTagPublished
1.4.2
latest
5yrs ago
No alternatives found
No tutorials found
Add a tutorial