Skip to content
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

chore: Remove the src directory from packages.json's files #1344

Merged
merged 2 commits into from
Aug 20, 2020

Conversation

sy-records
Copy link
Member

@sy-records sy-records commented Aug 20, 2020

Summary

close #1343

image

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Repo settings
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

@vercel
Copy link

vercel bot commented Aug 20, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/3g7nmuq1y
✅ Preview: https://docsify-preview-git-fork-sy-records-remove-src.docsify-core.vercel.app

@vercel vercel bot temporarily deployed to Preview August 20, 2020 00:09 Inactive
@sy-records sy-records requested review from anikethsaha and a team August 20, 2020 00:09
@codesandbox-ci
Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit f40c1c4:

Sandbox Source
docsify-template Configuration

@anikethsaha anikethsaha merged commit 5037f0b into docsifyjs:develop Aug 20, 2020
@sy-records sy-records deleted the remove-src branch August 20, 2020 06:07
Copy link
Member

@trusktr trusktr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking change. We should not remove src. Someone may depend on it. Why did you remove it?

@trusktr
Copy link
Member

trusktr commented Aug 21, 2020

@QingWei-Li Hello! We've been trying to save breaking changes for v5, but first we're stabilizing the code with tests (see Playwright PR, and some new files like docsify.test.js).

In my opinion, src files should always be published. This allows people to integrate source files into their own build systems which may be preferable over consuming built files (something I do quite often).

@anikethsaha
Copy link
Member

@trusktr IMO, I don't think we should publish that. is someone who wants to use the source file, they can very well pull it from the Github and also publishing the src folders will increase the package size unnecessary.

This is not a breaking change cause we never recommended nor stated anywhere in the docs to use these files and even if we did so, we should fix that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the src directory from packages.json's files
4 participants