Skip to content

Commit 7b9022a

Browse files
committed
remove: delete dist bundles as UMD bundles are now in standalone repos
1 parent 7fb88d4 commit 7b9022a

File tree

176 files changed

+8
-15799
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

176 files changed

+8
-15799
lines changed

README.md

+7-40
Original file line numberDiff line numberDiff line change
@@ -353,44 +353,6 @@ $ stdlib repl
353353

354354
### Environment Builds
355355

356-
<a name="install_env_builds_jquery"></a>
357-
358-
#### jQuery-like Bundle
359-
360-
For those wanting a jQuery-like bundle, one can use pre-built distributable UMD bundles for use in browser environments or as shared ("vendored") libraries in server environments, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles].
361-
362-
As an example, to include a UMD bundle exposing lower-level special [math functions][@stdlib/math/base/special] in a webpage, we can first locally install the UMD bundle package using [npm][npm]
363-
364-
<!-- run-disable -->
365-
366-
```bash
367-
$ npm install @stdlib/dist-math-base-special-flat
368-
```
369-
370-
and then include the following `<script>` tag in our HTML document
371-
372-
<!-- run-disable -->
373-
374-
```html
375-
<script type="text/javascript" src="/path/to/@stdlib/dist-math-base-special-flat/build/bundle.min.js"></script>
376-
```
377-
378-
making sure to modify the script path based on the local installation directory.
379-
380-
If no recognized module system is present, one can access bundle contents in another `<script>` tag via the global scope.
381-
382-
<!-- run-disable -->
383-
384-
```html
385-
<script type="text/javascript">
386-
// If no recognized module system present, exposed to global scope:
387-
var erf = stdlib_math_base_special_flat.erf;
388-
console.log( erf( 0.5 ) );
389-
</script>
390-
```
391-
392-
For more details and available bundles, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles]. The [guide][stdlib-bundles] includes instructions for consuming via CDNs, such as [unpkg][unpkg].
393-
394356
<a name="install_env_builds_esm"></a>
395357

396358
#### ES Modules
@@ -427,6 +389,13 @@ var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
427389
// returns <ndarray>
428390
````
429391

392+
393+
<a name="install_env_builds_jquery"></a>
394+
395+
#### jQuery-like Bundle
396+
397+
For those wanting a jQuery-like bundle, one can use pre-built distributable UMD bundles for use in browser environments or as shared ("vendored") libraries in server environments available in each package's repository via a dedicated `umd` branch. See sections [UMD](#install_env_builds_umd) and [Node.js](#install_env_builds_nodejs) for more details.
398+
430399
<a name="install_env_builds_umd"></a>
431400
432401
#### UMD
@@ -812,8 +781,6 @@ Test and build infrastructure is generously provided by the following services:
812781
813782
[stdlib-source]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib
814783
815-
[stdlib-bundles]: https://github.com/stdlib-js/stdlib/tree/develop/dist
816-
817784
[stdlib-code-coverage]: https://codecov.io/github/stdlib-js/stdlib/branch/develop
818785
819786
[open-collective-stdlib]: https://opencollective.com/stdlib

dist/README.md

+1-71
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ limitations under the License.
2626

2727
<section class="intro">
2828

29-
This directory contains packages exporting distributable files for use in browser environments or as shared ("vendored") libraries in server environments. Each distributable file is a standalone [UMD][umd] bundle which, if no recognized module system is present, will expose bundle contents to the global scope.
29+
This directory is reserved for packages exporting distributable files for use in browser environments or as shared ("vendored") libraries in server environments.
3030

3131
</section>
3232

@@ -36,44 +36,6 @@ This directory contains packages exporting distributable files for use in browse
3636

3737
<section class="usage">
3838

39-
## Usage
40-
41-
First, install one of the packages in this directory containing distributable files. For example, to install the main [stdlib][stdlib] bundle
42-
43-
```bash
44-
$ npm install --save @stdlib/dist-flat
45-
```
46-
47-
To use a package's default bundle in a webpage,
48-
49-
```html
50-
<script type="text/javascript" src="/path/to/node_modules/@stdlib/dist-<pkg>"></script>
51-
```
52-
53-
where `dist-<pkg>` corresponds to the desired published distributable file package.
54-
55-
To use a specific bundle (e.g., un-minified), include the bundle file path
56-
57-
```html
58-
<script type="text/javascript" src="/path/to/node_modules/@stdlib/dist-<pkg>/build/<bundle>.js"></script>
59-
```
60-
61-
where `<bundle>` corresponds to the desired bundle. For example, to include the un-minified bundle found in the package used in the example above
62-
63-
```html
64-
<script type="text/javascript" src="/path/to/@stdlib/dist-flat/build/bundle.js"></script>
65-
```
66-
67-
If no recognized module system is present, access bundle contents via the global scope. For example, assuming the flat namespace bundle sourced above,
68-
69-
```html
70-
<script type="text/javascript">
71-
// `stdlib` is a global variable...
72-
var erf = stdlib.base.erf;
73-
console.log( erf( 0.5 ) );
74-
</script>
75-
```
76-
7739
</section>
7840

7941
<!-- /.usage -->
@@ -82,22 +44,6 @@ If no recognized module system is present, access bundle contents via the global
8244

8345
<section class="notes">
8446

85-
## Notes
86-
87-
- Bundles are one of two namespace types: `flat` or `tree`. A `tree` namespace is a nested object namespace which mirrors the project's layout (e.g., `stdlib.math.base.special.erf`). A `flat` namespace uses the global alias [namespace][@stdlib/namespace], where each package has a unique alias (e.g., `stdlib.base.erf`). Which namespace is preferred depends on personal taste and application context.
88-
89-
- Each minified bundle has a corresponding [gzip][gzip]-compressed bundle. The [gzip][gzip] compression level for each compressed bundle is `9`, which is the highest (and most optimal) compression level. Deciding between uncompressed and compressed bundles depends on the application and whether compression is handled elsewhere in the application stack (e.g., [nginx][nginx], [CDN][cdn], _et cetera_).
90-
91-
- While you are **strongly** encouraged to **vendor** bundles and host with a [CDN][cdn]/provider which can provide availability **guarantees**, especially for production applications, bundles are available via [unpkg][unpkg] for quick demos, proof-of-concepts, and instructional material. For example,
92-
93-
```html
94-
<script type="text/javascript" src="https://unpkg.com/@stdlib/dist-flat"></script>
95-
```
96-
97-
Please be mindful that [unpkg][unpkg] is a free, best-effort service relying on donated infrastructure which does **not** provide **any** availability guarantees. Under **no** circumstances should you **abuse** or **misuse** the service. You have been **warned**.
98-
99-
- If you intend on embedding a standalone bundle **within** another bundle, you may need to rename `require` calls within the standalone bundle **before** bundling in order to maintain scoped module resolution. For example, if you plan on using [browserify][browserify] to generate a bundle containing embedded bundles, [browserify][browserify] plugins exist to "de-require" those bundles prior to bundling.
100-
10147
</section>
10248

10349
<!-- /.notes -->
@@ -106,22 +52,6 @@ If no recognized module system is present, access bundle contents via the global
10652

10753
<section class="links">
10854

109-
[umd]: https://github.com/umdjs/umd
110-
111-
[gzip]: https://en.wikipedia.org/wiki/Gzip
112-
113-
[nginx]: http://nginx.org/en/docs/
114-
115-
[cdn]: https://en.wikipedia.org/wiki/Content_delivery_network
116-
117-
[unpkg]: https://unpkg.com/#/
118-
119-
[browserify]: https://github.com/browserify/browserify
120-
121-
[stdlib]: https://github.com/stdlib-js/stdlib
122-
123-
[@stdlib/namespace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/namespace
124-
12555
</section>
12656

12757
<!-- /.links -->

dist/datasets-cmudict/LICENSE

-176
This file was deleted.

0 commit comments

Comments
 (0)