Skip to content
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

Convert to typescript #54

Merged
merged 6 commits into from
Apr 4, 2019
Merged

Convert to typescript #54

merged 6 commits into from
Apr 4, 2019

Conversation

zvin
Copy link
Contributor

@zvin zvin commented Mar 25, 2019

  • replace xml and htmlparser2 with xml-js;
  • remove nanobench;
  • remove file open/close from ReadStream;

Change-type: major

@@ -0,0 +1,78 @@
import { createReadStream, readFileSync } from 'fs';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I joined, Hedley explained that we should add the licence boilerplate at the top of every file we create or modify. If so, a conversion to typescript seems like a good opportunity to do it:

/**
 * @license
 * Copyright 2019 Balena Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And the CI complains about it apparently, so it's certainly something we should do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

@lurch
Copy link

lurch commented Mar 26, 2019

Seems like all the FilterStream stuff has disappeared from doc/README.md - is that deliberate?

 * replace xml and htmlparser2 with xml-js;
 * remove nanobench;
 * remove file open/close from ReadStream;

Change-type: major
Change-type: patch
Change-type: patch
@zvin
Copy link
Contributor Author

zvin commented Mar 26, 2019

@lurch docs updated, filter-stream is back

README.md Outdated
@@ -21,13 +21,13 @@ $ npm install --save blockmap
For detailed API documentation, see [`/doc`](https://github.com/resin-io-modules/blockmap/tree/master/doc).
Copy link

@lurch lurch Mar 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the URL here ought to be updated to balena-io-modules ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@lurch
Copy link

lurch commented Mar 26, 2019

Looks like there's now unintended duplication between README.md and doc/README.md ? 🤷‍♂️

@zvin
Copy link
Contributor Author

zvin commented Mar 26, 2019

Looks like there's now unintended duplication between README.md and doc/README.md ? man_shrugging

@lurch updated

Change-type: patch
@thundron
Copy link

thundron commented Apr 3, 2019

@resin-ci retest

Copy link

@pdcastro pdcastro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@thundron
Copy link

thundron commented Apr 3, 2019

@zvin Should we remove travis/appveyor actually? I see they fail and block the PR

@zvin zvin merged commit 2f25490 into master Apr 4, 2019
@zvin zvin deleted the typescript branch April 4, 2019 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants