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

minor documentation improvement - closes #7602 #7603

Merged
merged 5 commits into from
Sep 22, 2020

Conversation

michael-spengler
Copy link
Contributor

just a minor thing but it might help many devs to understand why some modules use deps.ts and some don't.

@CLAassistant
Copy link

CLAassistant commented Sep 20, 2020

CLA assistant check
All committers have signed the CLA.

@kitsonk
Copy link
Contributor

kitsonk commented Sep 20, 2020

You need to run ./tools/format.py on this (yeah, even markdown is linted 😄 )

@Skillz4Killz
Copy link

Skillz4Killz commented Sep 21, 2020

Maybe this is a good chance to bring up whether it should be added to the documentation about discouraging users from export from mod.ts

export * from "dep url/mod.ts"

You might be importing like 1000 different things when u only want a few things. Kinda like the npm problem where people started splitting up packages.
lodash/x
lodash/y

This allowed them to only have the parts they wanted to be imported instead of 10k things. Eventually you will get dependencies that have dependencies and you are back to the old node_modules system of having tons of unused imports.

Deno is awesome, because it allows you to pick & choose what you want for maximum efficiency.

export { stuff, that, you, need, only } from "dep url/specific url"

Which of the following would you recommend to someone?

export { delay } from "https://deno.land/std@0.67.0/async/delay.ts";

export * from "https://deno.land/std@0.67.0/async/mod.ts"

// Imagine if the lib actually had a main mod.ts file like what most libs are doing
export * from "https://deno.land/std@0.67.0/mod.ts"

@nayeemrmn
Copy link
Collaborator

Ref #6196 (review).

@michael-spengler
Copy link
Contributor Author

michael-spengler commented Sep 21, 2020

./tools/format.py

Screen Shot 2020-09-21 at 10 27 51 AM

Can anybody let me know what I missed here - I'm not so much into Python - rather a TypeScript guy :)

@lucacasonato
Copy link
Member

@michael-spengler You have to use python 2 for now. See #3294

@michael-spengler
Copy link
Contributor Author

@michael-spengler You have to use python 2 for now. See #3294

Screen Shot 2020-09-21 at 10 54 54 PM

still figuring things out :)

@lucacasonato
Copy link
Member

Did you clone submodules? git submodule update --init --recursive

@michael-spengler
Copy link
Contributor Author

git submodule update --init --recursive

Thank you @lucacasonato for your patience and sorry for not having checked this properly earlier: https://github.com/denoland/deno/blob/master/docs/contributing/building_from_source.md#cloning-the-repository

After git clone --recurse-submodules https://github.com/michael-spengler/deno.git michael-deno I ran it now and it formatted the .md file --> got stuck a bit later - don't know if this is relevant for this PR --> will anyhow look into it further - curiosity :)

Screen Shot 2020-09-21 at 11 41 25 PM

@lucacasonato
Copy link
Member

Formatting worked 👍

That issue happens because you don't have rust, cargo, or rustfmt installed.

@michael-spengler
Copy link
Contributor Author

Formatting worked 👍

That issue happens because you don't have rust, cargo, or rustfmt installed.

just doing so - installing ...

feeling like a Deno insider already :)

Screen Shot 2020-09-22 at 12 05 03 AM

I guess the PR is ready to merge - let me know if anything is open here.

@kitsonk kitsonk merged commit 5a8a4da into denoland:master Sep 22, 2020
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.

6 participants