Site-www: Add .dart_tool to 'What Not to Commit' page

[natebosch]

From URL: https://www.dartlang.org/guides/libraries/private-files

cc @kevmoo @jakemac53

We're likely going to be seeing more tools writing to .dart_tool/ and we should start recommending that this directory is ignored.

[natebosch]

@kevmoo - we could perhaps also add it to the default Dart .gitignore at https://github.com/github/gitignore/blob/master/Dart.gitignore

[chalin]

And update stagehand templates while we're at it?

[natebosch]

Good call, stagehand should include it too

[kevmoo]

We should be clear about the convention for .dart_tool, too. i.e. .dart_tool/<pkg>/...

Having an explicit call-out on www will give us a place to reference from pkg/build docs...

[devoncarew]

What is .dart_tool/? The scratch directory for package:build?

We already have a fair number of git ignored and or temporary file entities created by dart tooling (.pub/, build/, .packages). We may want to unify or simplify them a bit at this point.

[kevmoo]

.dart_tool was supposed to be "the place" for any package to put things in

.dart_tool/<pkg_name>

[devoncarew]

And the package would decide on the lifecycle for the contents for .dart_tool/foo? So a build tool might blow it away frequently, and a package management tool might keep the contents for a while?

What about just .dart/<pkg_name> then? .tools/<pkg_name>? .pkg/<pkg_name>?

Having a centralized convention + location sounds great.

[kevmoo]

Ha! We should have talked when we created .dart_tool.

I'd rather not switch it around now...

On Fri, Dec 8, 2017 at 9:13 PM, Devon Carew [e-mail]
wrote:

And the package would decide on the lifecycle for the contents for
.dart_tool/foo? So a build tool might blow it away frequently, and a
package management tool might keep the contents for a while?

What about just .dart/ then? .tools/? .pkg/?

Having a centralized convention + location sounds great.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/dart-lang/site-www/issues/444#issuecomment-350424813,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AABCirjjd4fVmYbBDdJoLFLAoih6I_tFks5s-hb6gaJpZM4QobWq
.

[devoncarew]

I've not seen the directory or heard of the convention to date, so I don't think there's a large numbers of existing uses to switch around -

[natebosch]

FWIW I prefer .dart_tool/ over the proposed alternatives.

.tool/ could be other development related stuff. .pkg/ is too much like the old packages/ but serves an entirely different purpose. .dart/ is OK but I like the extra clarity of including the word "tool".

I would be in favor of moving .pub to .dart_tool/pub