DOM re-structurings #84

nokome · 2020-02-26T22:55:02Z

Testing, refinement and additions to extensions to achieve short term stability in the DOM structure to be targeted by CSS. As per (the new) README:

Some extensions perform manipulation of the DOM to make it more amenable to achieving a particular CSS styling e.g. adding a wrapping <div>s. For performance reasons these manipulations should be kept to a minimum. In some cases, it may be better to make the necessary changes to Encoda's HTML codec. In those cases the DOM manipulations in the extension should be commented as being temporary, and be linked to an issue in Encoda to make those changes permanent.

@alex-ketch I'll only do the DOM manipulations, feel free to make an CSS changes necessary from these changes.

Done:

Person names
Headings
Check affiliations
References

…eate and append

codecov-io · 2020-02-26T23:03:22Z

Codecov Report

Merging #84 into next will increase coverage by 1.96%.
The diff coverage is 95.83%.

@@            Coverage Diff             @@
##             next      #84      +/-   ##
==========================================
+ Coverage   91.05%   93.02%   +1.96%     
==========================================
  Files           3        7       +4     
  Lines         123      172      +49     
  Branches       35       43       +8     
==========================================
+ Hits          112      160      +48     
- Misses         11       12       +1

Impacted Files	Coverage Δ
src/extensions/person/index.ts	`100% <100%> (ø)`
src/extensions/headings/index.ts	`100% <100%> (ø)`
src/extensions/cite/index.ts	`100% <100%> (ø)`
src/util/index.ts	`98.27% <93.33%> (-0.74%)`	⬇️
src/extensions/cite-apa/index.ts	`100% <0%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eddec64...70f69c3. Read the comment docs.

davidcmoulton

Looks interesting and useful 👍 Left a few comments / questions. Might have more questions when using it in anger once it's in next, but cross that bridge later.

src/util/index.test.ts

src/extensions/cite-apa/index.test.ts

src/extensions/cite/index.test.ts

src/extensions/cite-apa/index.test.ts

src/extensions/index.ts

src/util/index.test.ts

src/util/index.ts

alex-ketch

I've got some questions re. the Person encoding changes, and would like to see the type casting removed please.

src/extensions/cite/index.ts

src/extensions/index.ts

src/util/index.ts

See #84 (comment)

… semantics of `tag` when setting. See #84 (comment)

Fixes eslint npm script args, adds `no-shadow` rule and applies fixes. See #84 (comment)

See #84 (comment)

nokome · 2020-02-29T01:25:07Z

Thanks for the comments. I've done a round of changes. Please have another quick check and merge if happy.

Using `document.readyState !== 'loading'` is preferable because in both `interactive` and `complete` states the DOM is ready to be manipulated. See https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState

alex-ketch

One minor typo, but otherwise looks good.
Thanks for making the changes @nokome 🙇

src/util/index.ts

Co-Authored-By: Alex Ketch <[email protected]>

stencila-ci · 2020-03-02T23:24:50Z

🎉 This PR is included in version 1.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

nokome added 5 commits February 27, 2020 10:07

fix(Utility functions): Allow for camelCase property names

e7a673b

chore(Utilty functions): Export whenReady so it can be used in tests

5908c8a

fix(Utility function): Better type safety and more flexibility for cr…

7ef4cdd

…eate and append

fix(Person extension): DOM manipulations for more style-able names

cbdc70a

docs(README): Add note on DOM manipulations in extensions

45473d1

nokome assigned alex-ketch and nokome Feb 26, 2020

nokome requested a review from davidcmoulton February 26, 2020 22:55

nokome added 5 commits February 27, 2020 12:30

feat(Heading extension): Add in leiu of longer tem fix in Encoda

56619ee

feat(Utility functions): Add tag() and attrs(); return undefineds

71820f7

refactor(Headings extension): use tag func

249b24d

fix(Cite extension): Restructure and reorder reference properties

0d6e918

test(APA citations extension): Add a test

70f69c3

nokome requested a review from alex-ketch February 27, 2020 02:11

davidcmoulton reviewed Feb 27, 2020

View reviewed changes

alex-ketch reviewed Feb 27, 2020

View reviewed changes

src/extensions/cite/index.ts Show resolved Hide resolved

src/extensions/cite/index.ts Show resolved Hide resolved

src/extensions/index.ts Outdated Show resolved Hide resolved

src/util/index.ts Outdated Show resolved Hide resolved

src/util/index.ts Outdated Show resolved Hide resolved

alex-ketch mentioned this pull request Feb 28, 2020

Enable no-shadow ESLint rule stencila/dev-config#64

Open

nokome added 5 commits February 29, 2020 10:58

test(*): Use body variable in tests

36302ab

See #84 (comment)

refactor(Utility functions): Allow for both null and undefined; alter…

31f0f93

… semantics of `tag` when setting. See #84 (comment)

chore(*): Linting

8c7dc1e

Fixes eslint npm script args, adds `no-shadow` rule and applies fixes. See #84 (comment)

refactor(Utility functions): Remove cast

0c8291a

refactor(*): Ignore all generated files

059983d

See #84 (comment)

nokome mentioned this pull request Feb 29, 2020

HTML: Should handle <time> elements when decoding stencila/encoda#456

Open

docs(README): Add some notes on testing

cea7beb

nokome mentioned this pull request Mar 1, 2020

Refine and document available theme extensions #71

Closed

9 tasks

fix(Ready function): Use not loading, instead of complete

b61ceb1

Using `document.readyState !== 'loading'` is preferable because in both `interactive` and `complete` states the DOM is ready to be manipulated. See https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState

alex-ketch approved these changes Mar 2, 2020

View reviewed changes

src/util/index.ts Outdated Show resolved Hide resolved

Update src/util/index.ts

b7acf90

Co-Authored-By: Alex Ketch <[email protected]>

nokome merged commit 4a8b0ea into next Mar 2, 2020

nokome deleted the 71-structure branch March 2, 2020 23:15

stencila-ci added the released on @next label Mar 2, 2020

DOM re-structurings #84

DOM re-structurings #84

Uh oh!

Conversation

nokome commented Feb 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented Feb 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

davidcmoulton left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alex-ketch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nokome commented Feb 29, 2020

Uh oh!

alex-ketch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stencila-ci commented Mar 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

nokome commented Feb 26, 2020 •

edited

Loading

codecov-io commented Feb 26, 2020 •

edited

Loading

davidcmoulton left a comment •

edited

Loading