aflinchb / helium-typescript Goto Github PK

After removing the create/update/delete functionality, the actor and movie models are not actually being used anymore as implemented today. We need to decide what to do, if there's a way to use them in the results to specify the order that fields get serialized to make the JSON more readable and match C#'s ordering.

Currently it's almost a 100% duplicate of the C# Helium README. This is also capturing the need to solve where the "master" set of documentation lives, and what belongs in the language-specific versions of the repos.

This is not going to be implemented in this repo, but I wanted to capture the TODO.

Right now, I pass in an env variable that defaults to false that specifies if it's a dev run or not.
- So, when you want to run locally, call:
- export KeyVaultName={yourkeyvaultname}
- npm install (if not already)
- npm run build
- ISDEV=true npm start
I chose this instead of letting a call to get credentials fail and fall back on local/cloud. There's probably a better way.

Currently in C#, we only log on errors. The Node version as is logs descriptively, and often. We need to discuss if there's a reason to keep the additional logs and then keep it consistent across versions.

In addition to looking into out of date packages, below are the warnings I have seen:
npm WARN deprecated [email protected]: gulp-util is deprecated - replace it, following the guidelines at https://medium.com/gulpjs/gulp-util-ca3b1f9f9ac5
npm WARN deprecated [email protected]: please use require('restify').plugins
npm WARN deprecated [email protected]: Package no longer supported. Contact [email protected] for more info.
npm WARN deprecated [email protected]: Please note that v5.0.1+ of superagent removes User-Agent header by default, therefore you may need to add it yourself (e.g. GitHub blocks requests without a User-Agent header). This notice will go away with v5.0.2+ once it is released.
npm WARN deprecated [email protected]: Please use the native JSON object instead of JSON 3
npm WARN deprecated [email protected]: wrench.js is deprecated! You should check out fs-extra (https://github.com/jprichardson/node-fs-extra) for any operations you were using wrench for. Thanks for all the usage over the years.
npm WARN deprecated [email protected]: This module relies on Node.js's internals and will break at some point. Do not use it, and update to [email protected].
npm WARN deprecated [email protected]: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
npm WARN deprecated [email protected]: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
npm WARN deprecated [email protected]: please upgrade to graceful-fs 4 for compatibility with current and future versions of Node.js

https://github.com/4-co/helium-csharp

Mostly phrasing and cosmetic changes needed.
For reference: https://bluebell.azurewebsites.net/index.html

Either we should have this be a requirement for all Helium versions, or remove it to make it consistent across all languages.