Skip to content

Commit

Permalink
Change name of app in files.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmedley committed Mar 21, 2024
1 parent eb7b1b9 commit 449401d
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 27 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# mdn-helper
# MDNBanter
Removes repetitive work of creating MDN markup and text. Much of the work of creating a new MDN reference page is in creating boilerplate such as headings, specification tables, and standardized intro text. Once this is created API specific content must be added to the boilerplate. A significant portion of that content is duplicated between one or more pages of the API.

The current version only handles JavaScript APIs.
Expand All @@ -9,15 +9,15 @@ The current version only handles JavaScript APIs.

1. Clone this repository.

`git clone https://github.com/jpmedley/mdn-helper.git`
`git clone https://github.com/jpmedley/MDNBanter.git`

1. Change to the `mdn-helper` directory and run `npm install`.
1. Change to the `MDNBanter` directory and run `npm install`.

1. Enter `npm run update-data` to download data files needed for the `build`, `find`, and `report` commands. This script will run automatically on first use if it has been more than twenty-four hours since its last run.

## Usage

From within the mdn-helper direcory:
From within the MDNBanter direcory:

`npm run <command> [<arguments>] -- [<flags>]`

Expand Down Expand Up @@ -52,7 +52,7 @@ Generates a csv listing BCD entries where the browser value is either null or mi

### clean

Deletes selected folders from the `*path/to*/mdn-helper/out/` directory.
Deletes selected folders from the `*path/to*/MDNBanter/out/` directory.

**Syntax:** `clean`

Expand All @@ -69,7 +69,7 @@ display whether they exist.

### header

Creates pages for the provided HTTP header and directive names names. The results are written to the `*path/to*/mdn-helper/out/` directory. To build directive plages only, exclude the -H or --header flag.
Creates pages for the provided HTTP header and directive names names. The results are written to the `*path/to*/MDNBanter/out/` directory. To build directive plages only, exclude the -H or --header flag.

**Syntax:** <code>header -- -n _headerName_ [(-H | --header)] [(-d | --directive) _directiveName_]</code>

Expand All @@ -83,7 +83,7 @@ At least one of the following:

### interface

Creates one or more individual boilerplates for JavaScript platform APIs. The results are written to the `*path/to*/mdn-helper/out/` directory. The syntax description makes this look more complicated than it is. This can be summarized as `interface -n _interfaceName_` followed by commands for one or more individual pages. For example, the following would create a boilerplate for a property:
Creates one or more individual boilerplates for JavaScript platform APIs. The results are written to the `*path/to*/MDNBanter/out/` directory. The syntax description makes this look more complicated than it is. This can be summarized as `interface -n _interfaceName_` followed by commands for one or more individual pages. For example, the following would create a boilerplate for a property:

`npm run interface -n CSSTransformValue -p length`

Expand Down Expand Up @@ -140,9 +140,9 @@ When installed, no configuration is needed. [Instructions are provided](help/CON

## Data Sources

MDN Helper uses Chrome as its starting point because of the ease of reading API surfaces from its source code as compared to other browsers and because Chrome is often the first browser to implement new web platform features. (If you know of an easily downloaded data set that is a reliable proxy for the features of another browser, please contact me at the email address in my GitHub profile.)
MDNBanter uses Chrome as its starting point because of the ease of reading API surfaces from its source code as compared to other browsers and because Chrome is often the first browser to implement new web platform features. (If you know of an easily downloaded data set that is a reliable proxy for the features of another browser, please contact me at the email address in my GitHub profile.)

MDN Helper does not use data in web platform specs because working out which version of a spec to use as a starting point is not something that can be done algorithmically. Also, this tool was created to assist with new web platform features. For such featues, the first implementation may not include every feature described in a spec. Those unimplemented features can and do go through design changes before implementation.
MDNBanter does not use data in web platform specs because working out which version of a spec to use as a starting point is not something that can be done algorithmically. Also, this tool was created to assist with new web platform features. For such featues, the first implementation may not include every feature described in a spec. Those unimplemented features can and do go through design changes before implementation.

If you need to document a new feature that was implemented by a browser other than Chrome, see [Documenting New Features](help/BUILDING-PAGES.md#documenting-new-features).

Expand Down
2 changes: 1 addition & 1 deletion configuring.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuring mdn-helper
# Configuring MDNBanter

## Configuring for engineering users

Expand Down
10 changes: 5 additions & 5 deletions help/BUILDING-PAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ The `build` command helps you rapidly build JSON and HTML boilerplates for undoc
npm run build idl clipboard
```

MDN Helper searches for interfaces containing the string you entered prompts you with a list.
MDNBanter searches for interfaces containing the string you entered prompts you with a list.

**Note:** If you know a feature is supported in Chrome, but it does not appear in this list, see [Documenting New Features](#documenting-new-features) below.

![Possible interfaces to build](select-an-interface.png)

1. It checks for the existence of a JSON file for the interface in the [Browser compatibility Database](https://github.com/mdn/browser-compat-data). If the file does not exist, it creates a blank JSON file.
* The JSON file contains only false values. You will need to supply version numbers.
* MDN Helper writes the JSON file to a subfolder of `Desktop/out`.
1. For the interface and each of its members, MDN Helper pings the expected URL as listed in the Browser compatibility Database.
* MDNBanter writes the JSON file to a subfolder of `Desktop/out`.
1. For the interface and each of its members, MDNBanter pings the expected URL as listed in the Browser compatibility Database.

1. If pages are found to be missing for the selected interface, boilerplates will be written to the output directory using the same structure as required by "MDN/Content". If you used the interactive flag (`-i` or `--interactive`) you will be asked questions to gather information needed for the interface. This is no recommended for new MDN writers.

Expand All @@ -52,12 +52,12 @@ Do this with either the `-b` or `--bcdOnly` flag. For example:

## Documenting New Features

You may find that features behind a [runtime flag](https://www.howtogeek.com/703039/how-to-enable-google-chrome-flags-to-test-beta-features/) or in an [origin trial](https://web.dev/origin-trials/) in Chrome are not surfaced in the `build` or `find` commands. MDN Helper uses Chrome as its starting point because of the ease of reading API surfaces from its source code as compared to other browsers and because Chrome is often the first browser to implement new web platform features.
You may find that features behind a [runtime flag](https://www.howtogeek.com/703039/how-to-enable-google-chrome-flags-to-test-beta-features/) or in an [origin trial](https://web.dev/origin-trials/) in Chrome are not surfaced in the `build` or `find` commands. MDNBanter uses Chrome as its starting point because of the ease of reading API surfaces from its source code as compared to other browsers and because Chrome is often the first browser to implement new web platform features.

* If the feature is not yet available in another browser, it's too early to be documented on MDN. These statuses often indicate that aspects of a feature's design are still being resolved or tested and may change before the feature becomes part of the web platform. For early adoptors, resources can often be found in a feature's [spec repo](https://github.com/WICG/idle-detection). This includes the spec's explainer and sometimes MDN drafts specifically written for earlier adoptors.
**Note:** If you're documenting a new spec that has an MDN draft, you're encouraged to use that draft as the starting place for the MDN pages. These drafts conform to MDN standards and are written by either the spec designer or implementor.

* If the feature is available in another browser, you can tell MDN Helper to ignore that it is behind a flag or in an origin trial in Chrome by using the `-f` and `-o` flags. For example:
* If the feature is available in another browser, you can tell MDNBanter to ignore that it is behind a flag or in an origin trial in Chrome by using the `-f` and `-o` flags. For example:

```bash
npm run build idl clip -- -f -o
Expand Down
4 changes: 2 additions & 2 deletions help/CONFIGURING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuring MDN helper
# Configuring MDNBanter

The configuration file is located at `config/local.json`. There are only a few configuration values that you as a user would ever need to touch.

Expand All @@ -9,7 +9,7 @@ The folder where you want browser compatibility data to be written.

# Application.help

The amount of help text printed to the screen in interactive mode. Interactive mode is an advanced feature. You should create three or four APIs without interactive mode to become familliar with MDN Helper's output before attempting to use interactive mode.
The amount of help text printed to the screen in interactive mode. Interactive mode is an advanced feature. You should create three or four APIs without interactive mode to become familliar with MDNBanter's output before attempting to use interactive mode.

* `CONCISE`: Very little extra text is printed to the screen. You may want to change to this value after you are familiar with the application.

Expand Down
8 changes: 4 additions & 4 deletions help/HELP.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@
corresponding MDN page.

clean
Deletes selected folders from the *path/to*/mdn-helper/out/ directory.
Deletes selected folders from the *path/to*/MDNBanter/out/ directory.

css -- -n propertyName
Creates a page for a CSS property. The results are written to the
*path/to*/mdn-helper/out/ directory.
*path/to*/MDNBanter/out/ directory.

find css searchString
find idl searchString [(-p | --ping)]
Expand All @@ -43,15 +43,15 @@

header -- -n headerName [(-H | --header)] [(-d | --directive) directiveName]
Creates pages for the provided HTTP header and directive names
names. The results are written to the *path/to*/mdn-helper/out/
names. The results are written to the *path/to*/MDNBanter/out/
directory. To build directive plages only, exclude the -H or --header flag.

interface -- -n _interfaceName_ [-l] [-r] [-it] [-mp] [-mr]
[(-e | --event) _eventName_] [(-h | --handler) _handlerName_]
[(-m | --method) _methodName_] [(-p | --property) _propertyName_]
[(-w | --writefiles)]
Creates pages for JavaScript platform APIs. The results are written to the
*path/to*/mdn-helper/out/ directory.
*path/to*/MDNBanter/out/ directory.

update-data
Downloads a new set of IDL files for use by the `build`, `find`, and `report`
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@jpmedley/mdn-helper",
"name": "@jpmedley/MDNBanter",
"version": "1.1.1",
"description": "Removes repetitive work of creating MDN boilerplate markup and text.",
"main": "index.js",
Expand Down Expand Up @@ -28,7 +28,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/jpmedley/mdn-helper.git"
"url": "git+https://github.com/jpmedley/MDNBanter.git"
},
"keywords": [
"MDN",
Expand All @@ -45,7 +45,7 @@
"author": "Joseph Medley <[email protected]>",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/jpmedley/mdn-helper/issues"
"url": "https://github.com/jpmedley/MDNBanter/issues"
},
"dependencies": {
"@mdn/browser-compat-data": "^5.5.16",
Expand All @@ -66,5 +66,5 @@
"directories": {
"test": "test"
},
"homepage": "https://github.com/jpmedley/mdn-helper#readme"
"homepage": "https://github.com/jpmedley/MDNBanter#readme"
}
2 changes: 1 addition & 1 deletion utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ function _printHelp() {
function _printWelcome() {
console.clear();
console.log("=".repeat(80));
console.log(" ".repeat(30) + "Welcome to mdn-helper" + " ".repeat(29));
console.log(" ".repeat(30) + "Welcome to MDNBanter" + " ".repeat(29));
console.log("=".repeat(80));
}

Expand Down

0 comments on commit 449401d

Please sign in to comment.