app/views/doc/pubspec.html - Issue 162403002: Remove docs and point to ones on dartlang.org.

Unified Diff: app/views/doc/pubspec.html

Issue 162403002: Remove docs and point to ones on dartlang.org. (Closed) Base URL: https://github.com/dart-lang/pub-dartlang.git@master

Patch Set: Fit in 80 columns. Created 6 years, 10 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: app/views/doc/pubspec.html

diff --git a/app/views/doc/pubspec.html b/app/views/doc/pubspec.html

deleted file mode 100644

index cd990f0e8066737be00b8160bf7d6a01d3b26e80..0000000000000000000000000000000000000000

--- a/app/views/doc/pubspec.html

+++ /dev/null

@@ -1,174 +0,0 @@

-<ol class="toc">

- <li><a href="#name">Name</a></li>

- <li><a href="#version">Version</a></li>

- <li><a href="#description">Description</a></li>

- <li><a href="#authorauthors">Author/Authors</a></li>

- <li><a href="#homepage">Homepage</a></li>

- <li><a href="#documentation">Documentation</a></li>

- <li><a href="#dependencies">Dependencies</a></li>

- <li><a href="#sdk-constraints">SDK constraints</a></li>

-</ol>

-Every pub package needs some metadata so it can specify its

-<a href="glossary.html#dependency">dependencies</a>. Pub packages that are shared with

-others also need to provide some other information so users can discover them.

-Pub stores this in a file named <code>pubspec.yaml</code>, which (naturally) is written in

-the <a href="http://www.yaml.org/">YAML</a> language.

-At the top level are a series of fields. The currently supported ones are:

-<dl class="dl-horizontal">

- <dt>Name</dt>

- <dd>Required for every package.</dd>

- <dt>Version</dt>

- <dd>Required for packages that will be hosted on pub.dartlang.org.</dd>

- <dt>Description</dt>

- <dd>Required for packages that will be hosted on pub.dartlang.org.</dd>

- <dt>Author/Authors</dt>

- <dd>Optional.</dd>

- <dt>Homepage</dt>

- <dd>Optional.</dd>

- <dt>Documentation</dt>

- <dd>Optional.</dd>

- <dt>Dependencies</dt>

- <dd>Can be omitted if your package has no dependencies.</dd>

- <dt>Dev dependencies</dt>

- <dd>Can be omitted if your package has no dev dependencies.</dd>

-</dl>

-All other fields will be ignored. A simple but complete pubspec looks something

-like this:

-<div class="highlight"><pre><code class="yaml">name: newtify

-version: 1.2.3

-description: >

- Have you been turned into a newt? Would you like to be? This

- package can help: it has all of the newt-transmogrification

- functionality you've been looking for.

-author: Nathan Weizenbaum <nweiz@google.com>

-homepage: http://newtify.dartlang.org

-documentation: http://docs.newtify.com

-dependencies:

- efts: '>=2.0.4 <3.0.0'

- transmogrify: '>=0.4.0'

-dev_dependencies:

- unittest: '>=0.6.0'

-</code></pre></div>

-<h2 id="name">Name</h2>

-Every package needs a name. When your stellar code gets props on

-the world stage, this is what they’ll be hollering. Also, it’s how other

-packages will refer to yours, and how it will appear here, should you publish

-it.

-It should be all lowercase, with underscores to separate words,

-<code>just_like_this</code>. Stick with basic Latin letters and Arabic digits:

-<code>[a-z0-9_]</code> and ensure that it’s a valid Dart identifier (i.e. doesn’t start

-with digits and isn’t a reserved word).

-Try to pick a name that is clear, terse, and not already in use. A quick search

-<a href="/packages">here</a> to make sure nothing else is using your name can save you

-heartache later.

-<h2 id="version">Version</h2>

-Every package has a version. A version number is required to host your package

-here, but can be omitted for local-only packages. If you omit it, your package

-is implicitly versioned <code>0.0.0</code>.

-No one really gets excited about versioning, but it’s a necessary evil for

-reusing code while letting it evolve quickly. A version number is three numbers

-separated by dots, like <code>0.2.43</code>. It can also optionally have a build

-(<code>+hotfix.oopsie</code>) or pre-release (<code>-alpha.12</code>) suffix.

-Each time you publish your package, you will publish it at a specific version.

-Once that’s been done, consider it hermetically sealed: you can’t touch it

-anymore. To make more changes, you’ll need a new version.

-When you select a version, follow <a href="http://semver.org/">semantic versioning</a>. When you do, the

-clouds will part and sunshine will pour into your soul. If you don’t, prepare

-yourself for hordes of angry users.

-<h2 id="description">Description</h2>

-This is optional for your own personal packages, but if you intend to share

-your package with the world (and you should because, let’s be honest with

-ourselves, it’s a thing of beauty) you must provide a description. This should

-be relatively short—a few sentences, maybe a whole paragraph—and

-tells a casual reader what they might want to know about your package.

-Think of the description as the sales pitch for your package. Users will see it

-when they <a href="/packages">browse for packages</a>. It should be simple plain text:

-no markdown or HTML. That’s what your README is for.

-<h2 id="authorauthors">Author/Authors</h2>

-You’re encouraged to use these fields to describe the author(s) of your package

-and provide contact information. <code>author</code> should be used if your package has a

-single author, while <code>authors</code> should be used with a YAML list if more than one

-person wrote the package. Each author can either be a single name (e.g. <code>Nathan

-Weizenbaum</code>) or a name and an email address (e.g. <code>Nathan Weizenbaum

-<nweiz@google.com></code>). For example:

-<div class="highlight"><pre><code class="yaml">authors:

-- Nathan Weizenbaum <nweiz@google.com>

-- Bob Nystrom <rnystrom@google.com>

-</code></pre></div>

-If anyone uploads your package here, we will show this email address so make

-sure you’re OK with that.

-<h2 id="homepage">Homepage</h2>

-This should be a URL pointing to the website for your package. For

-<a href="#hosted-packages">hosted packages</a>, this URL will be linked from the

-package’s page. While this is technically optional please do provide one. It

-helps users understand where your package is coming from. If nothing else, you

-can always use the URL where you host the source code:

-<a href="http://github.com">GitHub</a>, <a href="http://code.google.com/">code.google.com</a>,

-whatever.

-<h2 id="documentation">Documentation</h2>

-Some packages may have a site that hosts documentation separate from the main

-homepage. If your package has that, you can also add a <code>documentation:</code> field

-with that URL. If provided, a link to it will be shown on your package’s page.

-<h2 id="dependencies">Dependencies</h2>

-<div class="learn-more">

- <a href="/doc/dependencies.html">

- Learn more about dependencies →

- </a>

-</div>

-Finally, the pubspec’s raison d’être: <a href="glossary.html#dependency">dependencies</a>. Here,

-you list each package that your package needs in order to work.

-There are two separate sections. Dependencies under <code>dependencies:</code> are

-“regular” dependencies. They are packages that anyone using your package will

-also need. Dependencies under <code>dev_dependencies</code> are

-<a href="glossary.html#dev-dependency">dev dependencies</a>. These are packages that are

-only needed in the development of your package itself.

-<h2 id="sdk-constraints">SDK constraints</h2>

-A package can indicate which versions of its dependencies it supports, but there

-is also another implicit dependency all packages have: the Dart SDK itself.

-Since the Dart platform evolves over time, a package may only work with certain

-versions of it.

-A package can specify that using an SDK constraint. This goes inside a

-separate top-level “environment” field in the pubspec and uses the same

-<a href="dependencies.html#version-constraints">version constraint</a> syntax as

-dependencies. For example, this constraint says that this package works with any

-Dart SDK from 0.3.4 or later:

-<div class="highlight"><pre><code class="yaml">environment:

- sdk: ">=0.3.4"

-</code></pre></div>

-Pub will try to find the latest version of a package whose SDK constraint works

-with the version of the Dart SDK that you have installed.

« no previous file with comments | « app/views/doc/pub-uploader.html ('k') | app/views/doc/versioning.html » ('j') | no next file with comments »