Commit Graph

26 Commits

Author SHA1 Message Date
whyisjake
3dd9628aae Build/Test Tools: Enable JSDocs to be linted with ESLint.
As part of the [Javascript Inline Docs Initiative](https://make.wordpress.org/core/handbook/docs/inline/js/) this add some tooling to lint Javascript docblocks. Two new commands:

* `npm run lint:jsdoc`
* `npm run lint:jsdoc:fix`

The latter will run the linter and try to fix an possible issues automatically.

Fixes #43828.
Props netweb, atimmer, kamataryo, whyisjake.


Built from https://develop.svn.wordpress.org/trunk@48650


git-svn-id: http://core.svn.wordpress.org/trunk@48412 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-27 23:35:02 +00:00
Sergey Biryukov
001ffe81fb Docs: Improve inline comments per the documentation standards.
Includes minor code layout fixes for better readability.

See #48303.
Built from https://develop.svn.wordpress.org/trunk@47122


git-svn-id: http://core.svn.wordpress.org/trunk@46922 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-29 00:45:18 +00:00
Sergey Biryukov
2a0489ec49 Docs: Replace @returns tags in JS docs with @return.
Per the documentation standards, `@returns` is an unsupported synonym, `@return` should be used instead:
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/

See #48303.
Built from https://develop.svn.wordpress.org/trunk@46800


git-svn-id: http://core.svn.wordpress.org/trunk@46600 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-29 18:01:03 +00:00
atimmer
bde558be2f Docs: Add file doc @output annotations.
These annotations make it clear to the reader of a JavaScript source
where the build process outputs to. These annotations can later be
integrated in a webpack configuration. This way there is one source of
truth.

The `build` folder is omitted from the paths, because a single JS file
shouldn't not be responsible of knowing where outputs in general will
end up at. A file only knows its output location relative to the
project.

Props adamsilverstein, herregroen, omarreiss, pento.
Fixes #44361.

Built from https://develop.svn.wordpress.org/trunk@43347


git-svn-id: http://core.svn.wordpress.org/trunk@43175 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-06-28 02:30:15 +00:00
atimmer
f6a37e7d39 Docs: Remove @summary tags from JSDoc.
As decided in the JavaScript core chat. With a few reasons:

* It is visually cleaner when reading the source.
* This bring the JavaScript documentation closer to the PHP documentation.

The only disadvantage is that the JSDoc parser doesn't split out the summary and the description in the new format. We've decided to solve this when building the JavaScript documentation parser.

Props herregroen.
Fixes #42901.

Built from https://develop.svn.wordpress.org/trunk@42411


git-svn-id: http://core.svn.wordpress.org/trunk@42240 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-12-18 14:14:53 +00:00
Sergey Biryukov
e8c65e0df1 Docs: Use 3-digit, x.x.x style semantic versioning for @since entries in wp-admin/js/word-count.js.
See #37718.
Built from https://develop.svn.wordpress.org/trunk@39739


git-svn-id: http://core.svn.wordpress.org/trunk@39679 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-01-06 22:12:39 +00:00
Scott Taylor
a9386ea7c1 Editor: improve word-count.js documentation.
Props jipmoors, andizer.
Fixes #37718.

Built from https://develop.svn.wordpress.org/trunk@38358


git-svn-id: http://core.svn.wordpress.org/trunk@38299 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-08-26 09:25:27 +00:00
Ella Iseulde Van Dorpe
491c863f35 Editor: word count: better names for types.
Also fix it in wp_trim_words().

Fixes #30966.

Built from https://develop.svn.wordpress.org/trunk@33440


git-svn-id: http://core.svn.wordpress.org/trunk@33407 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-27 11:19:26 +00:00
Ella Iseulde Van Dorpe
50159974c9 Editor: word count: exclude HTML comments and entities
Also make sure `type` is one of the three allowed types and remove unnecessary regex flags.

See #30966.

Built from https://develop.svn.wordpress.org/trunk@33344


git-svn-id: http://core.svn.wordpress.org/trunk@33316 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-21 15:24:24 +00:00
Ella Iseulde Van Dorpe
e9b6d25bcd Editor: word count: count astrals as one character
This makes sure an emoji, for example, is counted as one character.

See #30966.

Built from https://develop.svn.wordpress.org/trunk@33320


git-svn-id: http://core.svn.wordpress.org/trunk@33292 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-18 11:42:25 +00:00
Ella Iseulde Van Dorpe
f00d1e63f1 Editor: word count: exclude shortcodes
Props desaiuditd, adamsilverstein, azaozz and iseulde.
Fixes #27386. See #30966.

Built from https://develop.svn.wordpress.org/trunk@33299


git-svn-id: http://core.svn.wordpress.org/trunk@33271 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-16 21:09:26 +00:00
Ella Iseulde Van Dorpe
e098c0e9ee Editor: word count: exclude more characters
Also only exclude these characters for the `words` type. They should be counted for other types.
Add the ASCIIOnly option to the uglify config to preserve escaped unicode characters.

See #30966. Fixes #27391.


Built from https://develop.svn.wordpress.org/trunk@33292


git-svn-id: http://core.svn.wordpress.org/trunk@33264 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-16 09:45:26 +00:00
Ella Iseulde Van Dorpe
bbccb9ca6b Editor: word count: add all type
This type will count all characters including spaces.

See #30966.

Built from https://develop.svn.wordpress.org/trunk@33290


git-svn-id: http://core.svn.wordpress.org/trunk@33262 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-15 23:48:24 +00:00
Ella Iseulde Van Dorpe
fd95002b2a Editor: restructure word count
* The WordCounter should only do one thing: count words. This makes it also easier to test.
* Add some really basic unit tests.
* Instead of only refreshing the count on enter and delete, refresh the count when the user stops typing. Also look at paste and content changes in TinyMCE.
* Use `match` instead of `replace` when it is appropriate.
* More readable code.

See #30966. Fixes #26620.


Built from https://develop.svn.wordpress.org/trunk@32856


git-svn-id: http://core.svn.wordpress.org/trunk@32827 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-19 10:35:26 +00:00
Andrew Nacin
a66b92af4c JSHint fixes for word-count.js and wp-mediaelement.js. see #25187.
Built from https://develop.svn.wordpress.org/trunk@26209


git-svn-id: http://core.svn.wordpress.org/trunk@26117 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-15 06:52:09 +00:00
Andrew Nacin
2710bcade1 Switch to .min for compressed JS and CSS files.
* This moves our "development" versions from .dev.js to .js (same for css).
 * The compressed version then moves from .js to .min.js (same for css).

By switching to the standard .min convention, it sets expectations for developers,
and works nicely with existing tools such as ack.

fixes #21633.



git-svn-id: http://core.svn.wordpress.org/trunk@21592 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-08-23 00:04:18 +00:00
bumpbot
95f3fb0e57 Compress scripts/styles: 3.4-alpha-19967.
git-svn-id: http://svn.automattic.com/wordpress/trunk@19967 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-21 15:45:56 +00:00
nacin
2ca88e2c25 Revert character encoding issue in [19716].
git-svn-id: http://svn.automattic.com/wordpress/trunk@19718 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-08 23:17:46 +00:00
bumpbot
f15b9aa2e7 Compress scripts/styles: 3.4-alpha-19716.
git-svn-id: http://svn.automattic.com/wordpress/trunk@19716 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-08 23:05:52 +00:00
azaozz
3bb59dbc9c Fix autosave and word count for DFW HTML editor, always update word count on autosave, see #17136
git-svn-id: http://svn.automattic.com/wordpress/trunk@17936 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-05-16 06:17:44 +00:00
azaozz
258a8f6844 Distraction Free Writing mode, see #17136
git-svn-id: http://svn.automattic.com/wordpress/trunk@17695 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-04-25 01:01:34 +00:00
azaozz
8d96798043 wordcount.js fix for nbsp passed as #160 char, props Denis-de-Bernardy, fixes #9597
git-svn-id: http://svn.automattic.com/wordpress/trunk@11050 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2009-04-22 09:29:43 +00:00
azaozz
a750885c8e Minify all js and add the non-minified files as .dev.js
git-svn-id: http://svn.automattic.com/wordpress/trunk@10291 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2009-01-02 15:08:58 +00:00
ryan
35b18e5034 Trailing whitespace cleanup
git-svn-id: http://svn.automattic.com/wordpress/trunk@8600 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-08-09 05:36:14 +00:00
ryan
ed30026ce8 Word count fix from azaozz. fixes #6991
git-svn-id: http://svn.automattic.com/wordpress/trunk@8035 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-06-03 08:13:33 +00:00
ryan
123a6091fb Word count from azaozz. see #4807
git-svn-id: http://svn.automattic.com/wordpress/trunk@7854 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-04-29 19:17:23 +00:00