Docs update

dennisleung · Dec 3, 2020 · d1692b9 · d1692b9
1 parent 2fcfa81
commit d1692b9
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 76 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Breaking: "unsafe" tags `!!js/function`, `!!js/regexp`, `!!js/undefined` are
   moved to [js-yaml-js-types](https://github.com/nodeca/js-yaml-js-types) package.
-- Breaking: removed `safe*` functions. Use `load`, `loadAll`, `dump`, `dumpAll`
+- Breaking: removed `safe*` functions. Use `load`, `loadAll`, `dump`
   instead which are all now safe by default.
 - `yaml.DEFAULT_SAFE_SCHEMA` and `yaml.DEFAULT_FULL_SCHEMA` are removed, use
   `yaml.DEFAULT_SCHEMA` instead.

diff --git a/README.md b/README.md
@@ -46,38 +46,12 @@ Optional arguments:
 ```
 
 
-### Bundled YAML library for browsers
-
-``` html
-<!-- esprima required only for !!js/function -->
-<script src="esprima.js"></script>
-<script src="js-yaml.min.js"></script>
-<script type="text/javascript">
-var doc = jsyaml.load('greeting: hello\nname: world');
-</script>
-```
-
-Browser support was done mostly for the online demo. If you find any errors - feel
-free to send pull requests with fixes. Also note, that IE and other old browsers
-needs [es5-shims](https://github.com/kriskowal/es5-shim) to operate.
-
-Notes:
-
-1. We have no resources to support browserified version. Don't expect it to be
-   well tested. Don't expect fast fixes if something goes wrong there.
-2. `!!js/function` in browser bundle will not work by default. If you really need
-   it - load `esprima` parser first (via amd or directly).
-3. `!!bin` in browser will return `Array`, because browsers do not support
-   node.js `Buffer` and adding Buffer shims is completely useless on practice.
-
-
 API
 ---
 
 Here we cover the most 'useful' methods. If you need advanced details (creating
-your own tags), see [wiki](https://github.com/nodeca/js-yaml/wiki) and
-[examples](https://github.com/nodeca/js-yaml/tree/master/examples) for more
-info.
+your own tags), see [examples](https://github.com/nodeca/js-yaml/tree/master/examples)
+for more info.
 
 ``` javascript
 const yaml = require('js-yaml');
@@ -112,8 +86,7 @@ options:
     http://www.yaml.org/spec/1.2/spec.html#id2803231
   - `CORE_SCHEMA` - same as `JSON_SCHEMA`:
     http://www.yaml.org/spec/1.2/spec.html#id2804923
-  - `DEFAULT_SCHEMA` - all supported YAML types, without unsafe ones
-    (`!!js/undefined`, `!!js/regexp` and `!!js/function` are moved to [separate package](https://github.com/nodeca/js-yaml-js-types)).
+  - `DEFAULT_SCHEMA` - all supported YAML types.
 - `json` _(default: false)_ - compatibility with JSON.parse behaviour. If true, then duplicate keys in a mapping will override values rather than throwing an error.
 
 NOTE: This function **does not** understand multi-document sources, it throws
@@ -226,11 +199,9 @@ The list of standard YAML tags and corresponding JavaScript types. See also
 
 **JavaScript-specific tags**
 
-```
-!!js/regexp /pattern/gim            # RegExp
-!!js/undefined ''                   # Undefined
-!!js/function 'function () {...}'   # Function
-```
+See [js-yaml-js-types](https://github.com/nodeca/js-yaml-js-types) for
+extra types.
+
 
 Caveats
 -------

diff --git a/benchmark/samples/document_nodeca_application.yaml b/benchmark/samples/document_nodeca_application.yaml
@@ -89,14 +89,3 @@ bind:
 
   forum.index:
     mount: /
-
-  # ACTION, WHEN REQUESTED HOST IS UNKNOWN
-  #
-  # _ is a special keyword that hold function called when hostname is not
-  # supposed to be served by server listener, by default 404 not found:
-  #
-  #_: !!js/function |
-  #  function (req, res) {
-  #    res.writeHead(404, { 'Content-Type': 'text/plain' });
-  #    res.end('Invalid host ' + req.headers.host);
-  #  }
diff --git a/examples/custom_types.js b/examples/custom_types.js
@@ -5,7 +5,7 @@
 var fs   = require('fs');
 var path = require('path');
 var util = require('util');
-var yaml = require('../lib/js-yaml');
+var yaml = require('../');
 
 
 // Let's define a couple of classes.

diff --git a/examples/dumper.js b/examples/dumper.js
@@ -2,7 +2,7 @@
 
 /*eslint-disable no-console*/
 
-var yaml = require('../lib/js-yaml');
+var yaml = require('../');
 var object = require('./dumper.json');
 
 

diff --git a/examples/sample_document.js b/examples/sample_document.js
@@ -5,7 +5,7 @@
 var fs   = require('fs');
 var path = require('path');
 var util = require('util');
-var yaml = require('../lib/js-yaml');
+var yaml = require('../');
 
 
 try {

diff --git a/examples/sample_document.yml b/examples/sample_document.yml
@@ -121,24 +121,24 @@ merge:
   - &LEFT { x: 0, y: 2 }
   - &BIG { r: 10 }
   - &SMALL { r: 1 }
-  
+
   # All the following maps are equal:
-  
+
   - # Explicit keys
     x: 1
     y: 2
     r: 10
     label: nothing
-  
+
   - # Merge one map
     << : *CENTER
     r: 10
     label: center
-  
+
   - # Merge multiple maps
     << : [ *CENTER, *BIG ]
     label: center/big
-  
+
   - # Override
     << : [ *BIG, *LEFT, *SMALL ]
     x: 1
@@ -174,24 +174,3 @@ timestamp:
   space separated:  2001-12-14 21:59:43.10 -5
   no time zone (Z): 2001-12-15 2:59:43.10
   date (00:00:00Z): 2002-12-14
-
-
-# JavaScript Specific Types ####################################################
-################################################################################
-
-# https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp
-
-regexp:
-  simple: !!js/regexp      foobar
-  modifiers: !!js/regexp   /foobar/mi
-
-# https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/undefined
-
-undefined: !!js/undefined ~
-
-# https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function
-
-function: !!js/function >
-  function foobar() {
-    return 'Wow! JS-YAML Rocks!';
-  }
diff --git a/lib/loader.js b/lib/loader.js
@@ -134,7 +134,10 @@ function State(input, options) {
   this.filename  = options['filename']  || null;
   this.schema    = options['schema']    || DEFAULT_SCHEMA;
   this.onWarning = options['onWarning'] || null;
+  // (Hidden) Remove? makes the loader to expect YAML 1.1 documents
+  // if such documents have no explicit %YAML directive
   this.legacy    = options['legacy']    || false;
+
   this.json      = options['json']      || false;
   this.listener  = options['listener']  || null;