[dart-misc] Wish: Pub: Rename pubspeck.yaml to .pub

[Gen]

Hi,

I would like to have the pubspec.yaml file renamed to .pub.
This is easier and the file is displayed above all other files in the
directory and under the .packages file.

[Gen]

I have just seen that there is a ".pub" folder.
So ".pub.yaml" would be a better name.

Post by Gen
Hi,
I would like to have the pubspec.yaml file renamed to .pub.
This is easier and the file is displayed above all other files in the
directory and under the .packages file.

[Gen]

There is also a "pubspec.lock" file.
IMO this should be moved into the ".pub" directory or, if not possible,
renamed to ".pub.lock" .

Post by Gen
I have just seen that there is a ".pub" folder.
So ".pub.yaml" would be a better name.

Post by Gen
Hi,
I would like to have the pubspec.yaml file renamed to .pub.
This is easier and the file is displayed above all other files in the
directory and under the .packages file.

['Bob Nystrom' via Dart Misc]

As you can imagine, changing this today would break all the things. :)

The original reasons for choosing these names, which I believe are still
valid, are:

*Why not a dotfile for pubspec.yaml?*

- It's a visible, critical part of your package.
- It's intended to be checked into source control.
- It contains unique data that doesn't exist elsewhere. It's a single
point of truth.
- It is hand-edited by a human.
- Most other package managers do not make this a dotfile ("Gemfile",
"<gem>.gemspec", "package.json", "setup.py", etc.)

*Why .yaml for pubspec.yaml?*

- It *is* a YAML file.
- It communicates the expected format to authors.
- It tells text editors and IDEs how to syntax highlight it.

*Why not a dotfile for pubspec.lock?*

- Again, it's a visible, critical part of your package.
- Again, it's intended to be checked into source control.
- It contains unique data that doesn't exist elsewhere. It's a single
point of truth.
- It's not hand-edited, but it is hand-maintained by a user. You can
think of it is being "edited" by the user by invoking pub.

*Why .lock for pubspec.lock?*

- Since it isn't hand-edited in a text editor, we felt a ".yaml"
extension was less important.
- It follows Bundler which uses ".lock" for its lock file.
- Keeping the name "pubspec" (as opposed to something like
"publock.yaml") hints to where the file comes from.


*Why .pub for that directory?*

- It does not contain contain any unique data. It's just a cache of work
derived from data elsewhere.
- It's not intended to be viewed or modifed by humans.
- It's not intended to be checked into source control.


Cheers!

– bob

Post by Gen
There is also a "pubspec.lock" file.
IMO this should be moved into the ".pub" directory or, if not possible,
renamed to ".pub.lock" .

Post by Gen
I have just seen that there is a ".pub" folder.
So ".pub.yaml" would be a better name.

Post by Gen
Hi,
I would like to have the pubspec.yaml file renamed to .pub.
This is easier and the file is displayed above all other files in the
directory and under the .packages file.
--

For other discussions, see https://groups.google.com/a/dartlang.org/
For HOWTO questions, visit http://stackoverflow.com/tags/dart
To file a bug report or feature request, go to http://www.dartbug.com/new
To unsubscribe from this group and stop receiving emails from it, send an

[Gen]

Thanks for the reasonable explanations.
And I did not know that pub expects source files to be in the "lib"
directory.
Therefore pub related files and other files in the root directory of a
package are already separated from the source files.

Post by 'Bob Nystrom' via Dart Misc
As you can imagine, changing this today would break all the things. :)
The original reasons for choosing these names, which I believe are still
*Why not a dotfile for pubspec.yaml?*
- It's a visible, critical part of your package.
- It's intended to be checked into source control.
- It contains unique data that doesn't exist elsewhere. It's a single
point of truth.
- It is hand-edited by a human.
- Most other package managers do not make this a dotfile ("Gemfile",
"<gem>.gemspec", "package.json", "setup.py", etc.)
*Why .yaml for pubspec.yaml?*
- It *is* a YAML file.
- It communicates the expected format to authors.
- It tells text editors and IDEs how to syntax highlight it.
*Why not a dotfile for pubspec.lock?*
- Again, it's a visible, critical part of your package.
- Again, it's intended to be checked into source control.
- It contains unique data that doesn't exist elsewhere. It's a single
point of truth.
- It's not hand-edited, but it is hand-maintained by a user. You can
think of it is being "edited" by the user by invoking pub.
*Why .lock for pubspec.lock?*
- Since it isn't hand-edited in a text editor, we felt a ".yaml"
extension was less important.
- It follows Bundler which uses ".lock" for its lock file.
- Keeping the name "pubspec" (as opposed to something like
"publock.yaml") hints to where the file comes from.
*Why .pub for that directory?*
- It does not contain contain any unique data. It's just a cache of
work derived from data elsewhere.
- It's not intended to be viewed or modifed by humans.
- It's not intended to be checked into source control.
Cheers!
– bob

Post by Gen
There is also a "pubspec.lock" file.
IMO this should be moved into the ".pub" directory or, if not possible,
renamed to ".pub.lock" .

Post by Gen
I have just seen that there is a ".pub" folder.
So ".pub.yaml" would be a better name.

Post by Gen
Hi,
I would like to have the pubspec.yaml file renamed to .pub.
This is easier and the file is displayed above all other files in the
directory and under the .packages file.
--

For other discussions, see https://groups.google.com/a/dartlang.org/
For HOWTO questions, visit http://stackoverflow.com/tags/dart
To file a bug report or feature request, go to http://www.dartbug.com/new
To unsubscribe from this group and stop receiving emails from it, send an

[Günter Zöchbauer]

https://www.dartlang.org/tools/pub/package-layout.html contains some
information about pub package layout

Post by Gen
Thanks for the reasonable explanations.
And I did not know that pub expects source files to be in the "lib"
directory.
Therefore pub related files and other files in the root directory of a
package are already separated from the source files.

Post by 'Bob Nystrom' via Dart Misc
As you can imagine, changing this today would break all the things. :)
The original reasons for choosing these names, which I believe are still
*Why not a dotfile for pubspec.yaml?*
- It's a visible, critical part of your package.
- It's intended to be checked into source control.
- It contains unique data that doesn't exist elsewhere. It's a single
point of truth.
- It is hand-edited by a human.
- Most other package managers do not make this a dotfile ("Gemfile",
"<gem>.gemspec", "package.json", "setup.py", etc.)
*Why .yaml for pubspec.yaml?*
- It *is* a YAML file.
- It communicates the expected format to authors.
- It tells text editors and IDEs how to syntax highlight it.
*Why not a dotfile for pubspec.lock?*
- Again, it's a visible, critical part of your package.
- Again, it's intended to be checked into source control.
- It contains unique data that doesn't exist elsewhere. It's a single
point of truth.
- It's not hand-edited, but it is hand-maintained by a user. You can
think of it is being "edited" by the user by invoking pub.
*Why .lock for pubspec.lock?*
- Since it isn't hand-edited in a text editor, we felt a ".yaml"
extension was less important.
- It follows Bundler which uses ".lock" for its lock file.
- Keeping the name "pubspec" (as opposed to something like
"publock.yaml") hints to where the file comes from.
*Why .pub for that directory?*
- It does not contain contain any unique data. It's just a cache of
work derived from data elsewhere.
- It's not intended to be viewed or modifed by humans.
- It's not intended to be checked into source control.
Cheers!
– bob

Post by Gen
There is also a "pubspec.lock" file.
IMO this should be moved into the ".pub" directory or, if not possible,
renamed to ".pub.lock" .

Post by Gen
I have just seen that there is a ".pub" folder.
So ".pub.yaml" would be a better name.

Post by Gen
Hi,
I would like to have the pubspec.yaml file renamed to .pub.
This is easier and the file is displayed above all other files in the
directory and under the .packages file.
--

For other discussions, see https://groups.google.com/a/dartlang.org/
For HOWTO questions, visit http://stackoverflow.com/tags/dart
To file a bug report or feature request, go to
http://www.dartbug.com/new
To unsubscribe from this group and stop receiving emails from it, send