Refactors I18N logic #411
Refactors I18N logic #411
Conversation
cloudify
force-pushed
the
locales-yml
branch
2 times, most recently
from
6681f5e
to
f2c5140
Compare
* makes translation keys type safe * use YAML for translations (easier to edit for multiline strings) * adds compile time validation of translation keys
Example of PR titles that include pivotal stories:
New dependencies added: @types/chalkAuthor: Unknown Description: Stub TypeScript definitions entry for chalk, which provides its own types definitions Homepage: http://npmjs.com/package/@types/chalk
|
| Created | over 2 years ago |
| Last Updated | about 1 month ago |
| License | MIT |
| Maintainers | 1 |
| Releases | 39 |
| Direct Dependencies | @types/node |
README
Installation
npm install --save @types/fs-extra
Summary
This package contains type definitions for fs-extra (https://github.com/jprichardson/node-fs-extra).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra
Additional Details
- Last updated: Fri, 06 Jul 2018 21:56:16 GMT
- Dependencies: fs, node
- Global values: none
Credits
These definitions were written by Alan Agius https://github.com/alan-agius4, midknight41 https://github.com/midknight41, Brendan Forster https://github.com/shiftkey, Mees van Dijk https://github.com/mees-, Justin Rockwood https://github.com/jrockwood.
@types/js-yaml
Author: Unknown
Description: TypeScript definitions for js-yaml
Homepage: http://npmjs.com/package/@types/js-yaml
| Created | over 2 years ago |
| Last Updated | about 1 month ago |
| License | MIT |
| Maintainers | 1 |
| Releases | 21 |
| Direct Dependencies |
README
Installation
npm install --save @types/js-yaml
Summary
This package contains type definitions for js-yaml (https://github.com/nodeca/js-yaml).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-yaml
Additional Details
- Last updated: Wed, 04 Jul 2018 01:11:07 GMT
- Dependencies: none
- Global values: jsyaml
Credits
These definitions were written by Bart van der Schoor https://github.com/Bartvds, Sebastian Clausen https://github.com/sclausen.
@types/prettier
Author: Unknown
Description: TypeScript definitions for prettier
Homepage: http://npmjs.com/package/@types/prettier
| Created | about 1 year ago |
| Last Updated | about 1 month ago |
| License | MIT |
| Maintainers | 1 |
| Releases | 18 |
| Direct Dependencies |
README
Installation
npm install --save @types/prettier
Summary
This package contains type definitions for prettier (https://github.com/prettier/prettier).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/prettier
Additional Details
- Last updated: Mon, 16 Jul 2018 17:07:43 GMT
- Dependencies: none
- Global values: none
Credits
These definitions were written by Ika https://github.com/ikatyang.
chalk
Author: Unknown
Description: Terminal string styling done right
Homepage: https://github.com/chalk/chalk#readme
| Created | about 5 years ago |
| Last Updated | 3 days ago |
| License | MIT |
| Maintainers | 3 |
| Releases | 23 |
| Direct Dependencies | ansi-styles, escape-string-regexp and supports-color |
| Keywords | color, colour, colors, terminal, console, cli, string, str, ansi, style, styles, tty, formatting, rgb, 256, shell, xterm, log, logging, command-line and text |
fs-extra
Author: JP Richardson
Description: fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.
Homepage: https://github.com/jprichardson/node-fs-extra
| Created | almost 7 years ago |
| Last Updated | 10 days ago |
| License | MIT |
| Maintainers | 3 |
| Releases | 82 |
| Direct Dependencies | graceful-fs, jsonfile and universalify |
| Keywords | fs, file, file system, copy, directory, extra, mkdirp, mkdir, mkdirs, recursive, json, read, write, extra, delete, remove, touch, create, text, output and move |
README
Node.js: fs-extra
fs-extra adds file system methods that aren't included in the native fs module and adds promise support to the fs methods. It also uses graceful-fs to prevent EMFILE errors. It should be a drop in replacement for fs.
Why?
I got tired of including mkdirp, rimraf, and ncp in most of my projects.
Installation
npm install --save fs-extra
Usage
fs-extra is a drop in replacement for native fs. All methods in fs are attached to fs-extra. All fs methods return promises if the callback isn't passed.
You don't ever need to include the original fs module again:
const fs = require('fs') // this is no longer necessaryyou can now do this:
const fs = require('fs-extra')or if you prefer to make it clear that you're using fs-extra and not fs, you may want
to name your fs variable fse like so:
const fse = require('fs-extra')you can also keep both, but it's redundant:
const fs = require('fs')
const fse = require('fs-extra')Sync vs Async vs Async/Await
Most methods are async by default. All async methods will return a promise if the callback isn't passed.
Sync methods on the other hand will throw if an error occurs.
Also Async/Await will throw an error if one occurs.
Example:
const fs = require('fs-extra')
// Async with promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
.then(() => console.log('success!'))
.catch(err => console.error(err))
// Async with callbacks:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
if (err) return console.error(err)
console.log('success!')
})
// Sync:
try {
fs.copySync('/tmp/myfile', '/tmp/mynewfile')
console.log('success!')
} catch (err) {
console.error(err)
}
// Async/Await:
async function copyFiles () {
try {
await fs.copy('/tmp/myfile', '/tmp/mynewfile')
console.log('success!')
} catch (err) {
console.error(err)
}
}
copyFiles()Methods
Async
- copy
- emptyDir
- ensureFile
- ensureDir
- ensureLink
- ensureSymlink
- mkdirp
- mkdirs
- move
- outputFile
- outputJson
- pathExists
- readJson
- remove
- writeJson
Sync
- copySync
- emptyDirSync
- ensureFileSync
- ensureDirSync
- ensureLinkSync
- ensureSymlinkSync
- mkdirpSync
- mkdirsSync
- moveSync
- outputFileSync
- outputJsonSync
- pathExistsSync
- readJsonSync
- removeSync
- writeJsonSync
NOTE: You can still use the native Node.js methods. They are promisified and copied over to fs-extra. See notes on fs.read() & fs.write()
What happened to walk() and walkSync()?
They were removed from fs-extra in v2.0.0. If you need the functionality, walk and walkSync are available as separate packages, klaw and klaw-sync.
Third Party
TypeScript
If you like TypeScript, you can use fs-extra with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra
File / Directory Watching
If you want to watch for changes to files or directories, then you should use chokidar.
Obtain Filesystem (Devices, Partitions) Information
fs-filesystem allows you to read the state of the filesystem of the host on which it is run. It returns information about both the devices and the partitions (volumes) of the system.
Misc.
- fs-extra-debug - Send your fs-extra calls to debug.
- mfs - Monitor your fs-extra calls.
Hacking on fs-extra
Wanna hack on fs-extra? Great! Your help is needed! fs-extra is one of the most depended upon Node.js packages. This project
uses JavaScript Standard Style - if the name or style choices bother you,
you're gonna have to get over it :) If standard is good enough for npm, it's good enough for fs-extra.
What's needed?
- First, take a look at existing issues. Those are probably going to be where the priority lies.
- More tests for edge cases. Specifically on different platforms. There can never be enough tests.
- Improve test coverage. See coveralls output for more info.
Note: If you make any big changes, you should definitely file an issue for discussion first.
Running the Test Suite
fs-extra contains hundreds of tests.
npm run lint: runs the linter (standard)npm run unit: runs the unit testsnpm test: runs both the linter and the tests
Windows
If you run the tests on the Windows and receive a lot of symbolic link EPERM permission errors, it's
because on Windows you need elevated privilege to create symbolic links. You can add this to your Windows's
account by following the instructions here: http://superuser.com/questions/104845/permission-to-make-symbolic-links-in-windows-7
However, I didn't have much luck doing this.
Since I develop on Mac OS X, I use VMWare Fusion for Windows testing. I create a shared folder that I map to a drive on Windows.
I open the Node.js command prompt and run as Administrator. I then map the network drive running the following command:
net use z: "\\vmware-host\Shared Folders"
I can then navigate to my fs-extra directory and run the tests.
Naming
I put a lot of thought into the naming of these functions. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:
- Merge with fs.extra and mkdirp jprichardson/node-fs-extra#2
- other fs modules to merge in flatiron/utile#11
- join forces with fs.extra, fs-extra, and others? ryanmcgrath/wrench-js#29
- https://github.com/substack/node-mkdirp/issues/17
First, I believe that in as many cases as possible, the Node.js naming schemes should be chosen. However, there are problems with the Node.js own naming schemes.
For example, fs.readFile() and fs.readdir(): the F is capitalized in File and the d is not capitalized in dir. Perhaps a bit pedantic, but they should still be consistent. Also, Node.js has chosen a lot of POSIX naming schemes, which I believe is great. See: fs.mkdir(), fs.rmdir(), fs.chown(), etc.
We have a dilemma though. How do you consistently name methods that perform the following POSIX commands: cp, cp -r, mkdir -p, and rm -rf?
My perspective: when in doubt, err on the side of simplicity. A directory is just a hierarchical grouping of directories and files. Consider that for a moment. So when you want to copy it or remove it, in most cases you'll want to copy or remove all of its contents. When you want to create a directory, if the directory that it's suppose to be contained in does not exist, then in most cases you'll want to create that too.
So, if you want to remove a file or a directory regardless of whether it has contents, just call fs.remove(path). If you want to copy a file or a directory whether it has contents, just call fs.copy(source, destination). If you want to create a directory regardless of whether its parent directories exist, just call fs.mkdirs(path) or fs.mkdirp(path).
Credit
fs-extra wouldn't be possible without using the modules from the following authors:
License
Licensed under MIT
Copyright (c) 2011-2017 JP Richardson
js-yaml
Author: Vladimir Zapparov
Description: YAML 1.2 parser and serializer
Homepage: https://github.com/nodeca/js-yaml
| Created | almost 7 years ago |
| Last Updated | 18 days ago |
| License | MIT |
| Maintainers | 1 |
| Releases | 64 |
| Direct Dependencies | argparse and esprima |
| Keywords | yaml, parser, serializer and pyyaml |
Generated by 🚫 dangerJS
TODO: