Controller API Declarations blogpost #341
Conversation
|
Thank you for the bog post. It looks good so far. |
Shipping with Mixxx makes not much sense, because the paths are always different. Generating can work, but there might be conflicts if we do it automatic, because we put all scripts in the same directory, and |
|
Can we publish this? |
| ## How to use it? | ||
| Development of mappings and controller scripts is usually done in the subdirectory `controllers` of the [Mixxx Settings Directory](https://manual.mixxx.org/latest/chapters/appendix/settings_directory), while the common files (like `common-controller-scripts.js`) which comes with Mixxx, are store in the subdirectory `controllers` of Mixxx installation directory, or `./mixxx/res/controllers` if you built Mixxx yourself. This is also the location, where the TypeScript files with the declarations of the Mixxx controller API are stored. The LSP language server need to know the location of all of them. To tell the LSP server general settings and the locations of these files, you need to create a file with the name `jsconfig.json` placed next to your JavaScript controller script file, in the `controllers` directory in your `Mixxx Settings Directory`. |
There was a problem hiding this comment.
This is very technical and detailed while not being very relevant timely.
I think this belongs almost entirely somewhere on the wiki instead.
There was a problem hiding this comment.
I agree here. Can we describe it in a wiki and just link it here?
We need a wiki entry anyway. Maybe also a Readme.txt in the controller folder?
How about installing a jsconfig.json.template file with a comment how to adjust and use it?
There was a problem hiding this comment.
Sorry, but this is the essence of this blog post! Without knowing how to use the sample content of this file, it is completely incomprehensible for a mapping developer how to use this functionality.
Everything else in this post is just an explanation, but that's what I want to share with the mapping community here!
Feel free to copy elsewhere - but please don't make me remove this post from my blog post.
There was a problem hiding this comment.
IMHO this certainly deserves to be a newspost.
This is news, though it's more technical it definitely has it's public.
Articles like this make the difference: Mixxx isn't just a program like 13 in a dozen, there's a lot of added value and although we're not literaly selling something the (shared) knowledge / flexibility / support (not treating users as complete idiots) all are part of Mixxx's USP (Unique Selling Point).
Not everyone reads the wiki on regular bases but rather when they are dealing with a problem or looking for particular information. If articles like this don't get (news-) attention the info might got lost between the other info (that can be overwelming). The readers can choose to read it or not (if it's too technical for them).
The Wiki also needs an 'updated / new' - intro (simular to changelog)
There was a problem hiding this comment.
Sorry, but this is the essence of this blog post! Without knowing how to use the sample content of this file, it is completely incomprehensible for a mapping developer how to use this functionality. Everything else in this post is just an explanation, but that's what I want to share with the mapping community here! Feel free to copy elsewhere - but please don't make me remove this post from my blog post.
yeah... makes sense. Lets copy it to an appropriate page in the wiki after publishing the article.
There was a problem hiding this comment.
Do you have a place in mind, where I should copy it to?
There was a problem hiding this comment.
maybe right at the beginning of https://github.com/mixxxdj/mixxx/wiki/midi%20scripting#set-up-a-javascript-mapping ?
|
It would be nice, if we could publish my 2.4 feature post finally... |
So this is the explanation of the magic, I couldn't get it to work yet but maybe with this doc it could work, I'll try. Thank you for the doc. |
| ## How to use it? | ||
| Development of mappings and controller scripts is usually done in the subdirectory `controllers` of the [Mixxx Settings Directory](https://manual.mixxx.org/latest/chapters/appendix/settings_directory), while the common files (like `common-controller-scripts.js`) which comes with Mixxx, are store in the subdirectory `controllers` of Mixxx installation directory, or `./mixxx/res/controllers` if you built Mixxx yourself. This is also the location, where the TypeScript files with the declarations of the Mixxx controller API are stored. The LSP language server need to know the location of all of them. To tell the LSP server general settings and the locations of these files, you need to create a file with the name `jsconfig.json` placed next to your JavaScript controller script file, in the `controllers` directory in your `Mixxx Settings Directory`. |
There was a problem hiding this comment.
I agree here. Can we describe it in a wiki and just link it here?
We need a wiki entry anyway. Maybe also a Readme.txt in the controller folder?
How about installing a jsconfig.json.template file with a comment how to adjust and use it?
|
IMHO I think the time is right to publish this newsitem. |
|
sure... just needs the merge conflict resolved and a squash would be nice too. |
JoergAtGithub
force-pushed
the
controllerAPI_declarations
branch
from
6290ce5
to
6cdcaf8
Compare
|
can you also resolve your review @daschuer? |
|
Thank you. |
No description provided.