Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Add an optional _FYI key or similar for the persistent properties JSON file #122

Closed
kevmoo opened this issue Apr 19, 2018 · 5 comments
Closed
Labels
type-enhancement A request for a change that isn't a bug

Comments

@kevmoo
Copy link
Contributor

kevmoo commented Apr 19, 2018

If I run into ~/.stagehand and open it

{
  "firstRun": false,
  "enabled": true,
  "clientId": "XYZ..."
}

I may wonder what's going on.

If I saw...

{
  "_FYI": "This file stores Google Analytics settings for https://pub.dartlang.org/packages/stagehand",
  "firstRun": false,
  "enabled": true,
  "clientId": "XYZ..."
}

I'd be much less confused...

@kevmoo kevmoo added the type-enhancement A request for a change that isn't a bug label Apr 19, 2018
@kevmoo
Copy link
Contributor Author

kevmoo commented Apr 19, 2018

Thoughts, @devoncarew ?

@devoncarew
Copy link
Contributor

That sounds reasonable. We could also parse and ignore leading # foo lines, and generate the file with a comment:

# This file stores Google Analytics settings for https://pub.dartlang.org/packages/stagehand.

{
  "firstRun": false,
  "enabled": true,
  "clientId": "XYZ..."
}

@devoncarew
Copy link
Contributor

Or, just convert it entirely to a .properties file...

@kevmoo
Copy link
Contributor Author

kevmoo commented Apr 19, 2018 via email

@devoncarew
Copy link
Contributor

closing as we're no longer going to actively work on this package (#195)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type-enhancement A request for a change that isn't a bug
Development

No branches or pull requests

2 participants