New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing READMEs on core package detail pages #17868

Merged
merged 1 commit into from Aug 16, 2018

Conversation

Projects
None yet
1 participant
@daviwil
Member

daviwil commented Aug 15, 2018

Description of the Change

This change fixes atom/settings-view#1069 which reports that README file information is no longer displayed on core package detail pages in the Settings view, like that of the About package. It turns out that this issue was introduced in Atom 1.21.0 by the reintroduction of ASAR packaging (#14682). When we package Atom's node_modules folder into the ASAR file, we exclude files with certain file extensions:

'node_modules' + escapeRegExp(path.sep) + '.*' + '\\.md$',

This change removes the exclusion of .md files from the ASAR files so that README.md and LICENSE.md files are now available for the package details page to display.

Alternate Designs

README information is read from README.md files contained within package folders so this is the only solution.

Why Should This Be In Core?

It affects how core package details are displayed in

Benefits

READMEs for for core Atom packages are now displayed in the Settings view.

Possible Drawbacks

Marginally increased ASAR size by including core package .md files.

Verification Process

  • Verify that README for core packages are now visible after this change
  • Verify that license details for core package are displayed after this change

Screenshot of about package README displayed in Atom after this change:

image

Applicable Issues

atom/settings-view#1069

Fix missing READMEs on core package detail pages
Fixes atom/settings-view#1069

Co-Authored-By: Tilde Ann Thurium <annthurium@github.com>

@daviwil daviwil merged commit a03aac7 into master Aug 16, 2018

2 of 3 checks passed

VSTS: Atom Pull Requests 20180815.4 failed
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@daviwil daviwil deleted the dw-fix-missing-readmes branch Aug 16, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment