2e:null 2f:["$","title",null,{"children":"Elm 0.19 Conflicting modules | Jakub Hampl | Observable"}] 34:[] 32:{"id":"353e4e0dd87166db","slug":"elm-0-19-conflicting-modules","title":"Elm 0.19 Conflicting modules","thumbnail":"60705407aecbf7ea41e3a7d09bd858b883f5244a718f347627de605bda07e235","access_level":"public","create_time":"$D2019-01-22T11:23:55.406Z","update_time":"$D2019-01-23T12:46:24.950Z","view_time":null,"first_public_time":"$D2019-01-22T13:41:37.175Z","has_unpublished_edits":null,"fork":false,"stars":0,"starred":false,"owner":{"type":"team","id":"a2f700b6ce27b844","login":"gampleman","name":"Jakub Hampl","avatar_url":"https://avatars-next.observableusercontent.com/6ee048ed02abfd79e76f2f9dd7c7e8658c47b116d846f2f9ca8814ecdde18ffc","tier":"starter_2024"},"version":112,"publish_version":112,"role":null,"authored":false,"authors":[{"type":"individual","id":"34d15c3b1cc754ed","login":"gampleman","name":"Jakub Hampl","avatar_url":"https://avatars-next.observableusercontent.com/6ee048ed02abfd79e76f2f9dd7c7e8658c47b116d846f2f9ca8814ecdde18ffc","tier":null}],"members":[{"type":"individual","id":"34d15c3b1cc754ed","login":"gampleman","name":"Jakub Hampl","avatar_url":"https://avatars-next.observableusercontent.com/6ee048ed02abfd79e76f2f9dd7c7e8658c47b116d846f2f9ca8814ecdde18ffc","tier":null,"role":"editor"}],"comments":[],"custom_thumbnail":false,"trashed":false,"lapsed":null,"subscribed":null,"forks":1,"collection":null,"type":"notebook","body":{"title":"Elm 0.19 Conflicting modules","cells":[{"id":0,"value":"md`# Elm 0.19 Conflicting modules\n\nIn this notebook we explore the possibility of conflicting module names being used in a single project.\n\n### All Conflicts\n\nFirst, we'll look at a naive solution, where we simply see all module names that are conflicting:`\n\n","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":16,"value":"viewof allDuplicates = filterClashes(a => a, a => false, (a, b) => false)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":64,"value":"md`## Filtering out unlikely\n\nHowever, this has many duplicates that are not likely to ever appear in the same project, like various pre-releases, implementations of the same CSS framework, etc. For this we will filter out things that share the same author or same package name (assuming these are forks):`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":21,"value":"filterOutUnlikely = (a, b) => author(a) == author(b) || name(a) == name(b) || a == 'lukewestby/accessible-html-with-css-temp-19@1.0.0' && b == 'tesk9/accessible-html-with-css@2.0.0'","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":74,"value":"md`and are from a list of CSS frameworks:`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":32,"value":"noCSSFramework = (mod, pack) => [\"rundis/elm-bootstap@5.1.0\", \"frandibar/elm-bootstrap@2.0.0\", \"JeremyBellows/elm-bootstrapify@9.0.1\", \"JeremyBellows/elm-bootstrapify@9.0.1\", \"afidegnum/elm-bulmanizer@1.0.0\"].includes(pack)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":20,"value":"filteredDuplicates = filterClashes(a => a, noCSSFramework, filterOutUnlikely)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":77,"value":"md`## Do authors mitigate for this?\n\nHowever, it is likely that authors are afraid of this problem already (I know, since I've done this myself) and are conciosly mitigating this issue. One of the easiest ways to do that is to prefix the module you want to expose with something, usually related to the package name. We can attempt to check for that:`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":81,"value":"viewof normalised = filterClashes(mod => { const comp = mod.split('.'); return comp.length > 1 ? (comp.shift(), comp.join('.')) : comp.join('.') }, noCSSFramework, filterOutUnlikely)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":110,"value":"md`## In conclusion\n\nAre namespace collisions real? Yes. But they are rare. Looking through the second list, it looks like only a handful of genuine issues. One I can relate to right away is \\`Force\\` - it is used in gampleman/elm-visualization and ianmackenzie/elm-units, which are projects that both are targeted at similar audiences and do very different things (one does a force simulation and the other describes units of force).\n\nHowever, if the language would solve this problem transparently for the user, then many more modules may loose potentially unnecessary prefixes (one example from my own libraries is \\`Mapbox.Style\\` from gampleman/elm-mapbox. The Mapbox prefix is fairly unnecessary - all the modules in the library refer to Mapbox stuff. But \\`Style\\` is a very common word in web development and so it having real clashes in common applications was a certainty. \n\nEither way, you can use stuff in this notebook to analyse the data however you want - all the code is live and editable. \n`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4,"value":"modules = {\n const result = await (await fetch('https://gist.githubusercontent.com/rlefevre/dfa40a225a2391f70a1a8127aa692385/raw/53c185e44d4fffaa0db9bbe40088b00de4266747/elm-modules-names.json')).json()\n return Object.entries(result).flatMap(([k, vals]) => vals.map(v => [k, v]))\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":39,"value":"display = (data) => {\n const entries = Object.entries(data);\n const count = entries.length;\n const ui = html`

Found ${count} conflicting modules (around ${Math.round((count / modules.length * 100))}% of all modules).

\n ${entries.map(([mod, packages]) => `

${mod}: ${packages.map(p => {\n const [pack, vers] = p.package.split('@');\n return `${pack}`\n }).join(\", \")}

`).join('')}\n

`;\n ui.value = data;\n return ui;\n \n};","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":13,"value":"filterClashes = (normalise, ignore, duplicates) => {\n const objectFromEntries = arr => arr.reduce((obj, [k, v]) => (obj[k] = v, obj), {});\n \n const normalized = Object.entries(modules.filter(([mod, pack]) => !ignore(mod, pack)).reduce((obj, [mod, pack]) => {\n const key = normalise(mod, pack);\n obj[key] || (obj[key] = []);\n obj[key].push({package: pack, module: mod});\n return obj;\n }, {}));\n \n normalized.sort();\n \n \n return display(objectFromEntries(normalized.filter(([mod, vals]) => {\n if (vals.length > 1) {\n let nonDupes = [];\n for (let i = 0, l = vals.length; i < l; i++) {\n let isDuped = false;\n for (let j = i + 1; j < l; j++) {\n if (duplicates(vals[i].package, vals[j].package, mod)) {\n isDuped = true;\n break;\n }\n }\n if (!isDuped) {\n nonDupes.push(vals[i]);\n }\n }\n return nonDupes.length > 1;\n } else {\n return false;\n }\n })));\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":27,"value":"author = pack => pack.split('/')[0]","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":85,"value":"name = pack => pack.split('/')[1].split('@')[0]","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"}],"files":"$W34","stdlib":"1","titling":"auto"}} 33:"$32:body"