tslint-folders - v0.0.0-semantically-released
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
IS_
DEBUG_
ENABLED
clean
Path
determine
Package
Folder
And
Name
determine
Package
Location
From
Path
determine
Package
Location
With
Sub
Folder
determine
Package
Name
get
Package
Name
is
Package
Third
Party
is
Relative
Import
is
This
Package
Third
Party
log
Package
And
Import
should
Ignore
File
should
Ignore
Path
Index
Variables
IS_
DEBUG_
ENABLED
Functions
clean
Path
determine
Package
Folder
And
Name
determine
Package
Location
From
Path
determine
Package
Location
With
Sub
Folder
determine
Package
Name
get
Package
Name
is
Package
Third
Party
is
Relative
Import
is
This
Package
Third
Party
log
Package
And
Import
should
Ignore
File
should
Ignore
Path
Variables
Const
IS_
DEBUG_
ENABLED
IS_
DEBUG_
ENABLED
:
false
= false
Functions
clean
Path
clean
Path
(
filePath
:
string
)
:
string
Parameters
filePath:
string
Returns
string
determine
Package
Folder
And
Name
determine
Package
Folder
And
Name
(
config
:
ImportsBetweenPackagesRuleConfig
, dirs
:
string
[]
, filePath
:
string
, thisPackageLocation
:
PackageLocation
|
undefined
, packageName
:
string
, pathSource
:
PathSource
, ruleId
:
string
)
:
object
Parameters
config:
ImportsBetweenPackagesRuleConfig
dirs:
string
[]
filePath:
string
thisPackageLocation:
PackageLocation
|
undefined
packageName:
string
pathSource:
PathSource
ruleId:
string
Returns
object
package
Folder
:
PackageFolder
|
undefined
package
Name
:
string
determine
Package
Location
From
Path
determine
Package
Location
From
Path
(
filePath
:
string
, ruleId
:
string
, config
:
ImportsBetweenPackagesRuleConfig
, pathSource
:
PathSource
, thisPackageLocation
?:
PackageLocation
)
:
PackageLocation
Parameters
filePath:
string
ruleId:
string
config:
ImportsBetweenPackagesRuleConfig
pathSource:
PathSource
Optional
thisPackageLocation:
PackageLocation
Returns
PackageLocation
determine
Package
Location
With
Sub
Folder
determine
Package
Location
With
Sub
Folder
(
dirs
:
string
[]
, packageName
:
string
, packageFolder
:
PackageFolder
, pathSource
:
PathSource
)
:
PackageLocation
Parameters
dirs:
string
[]
packageName:
string
packageFolder:
PackageFolder
pathSource:
PathSource
Returns
PackageLocation
determine
Package
Name
determine
Package
Name
(
config
:
ImportsBetweenPackagesRuleConfig
, dirs
:
string
[]
, pathSource
:
PathSource
)
:
string
|
null
Parameters
config:
ImportsBetweenPackagesRuleConfig
dirs:
string
[]
pathSource:
PathSource
Returns
string
|
null
get
Package
Name
get
Package
Name
(
packageFolder
:
PackageFolder
|
undefined
)
:
string
Parameters
packageFolder:
PackageFolder
|
undefined
Returns
string
is
Package
Third
Party
is
Package
Third
Party
(
folderLocation
:
PackageLocation
)
:
boolean
Parameters
folderLocation:
PackageLocation
Returns
boolean
is
Relative
Import
is
Relative
Import
(
pathDir
:
string
)
:
boolean
Parameters
pathDir:
string
Returns
boolean
is
This
Package
Third
Party
is
This
Package
Third
Party
(
thisFolderLocation
:
PackageLocation
, node
:
Node
)
:
boolean
Parameters
thisFolderLocation:
PackageLocation
node:
Node
Returns
boolean
log
Package
And
Import
log
Package
And
Import
(
node
:
Node
, thisPackageLocation
:
PackageLocation
, importPackageLocation
:
PackageLocation
)
:
void
Parameters
node:
Node
thisPackageLocation:
PackageLocation
importPackageLocation:
PackageLocation
Returns
void
should
Ignore
File
should
Ignore
File
(
node
:
Node
, ignorePaths
:
string
[]
)
:
boolean
Parameters
node:
Node
ignorePaths:
string
[]
Returns
boolean
should
Ignore
Path
should
Ignore
Path
(
path
:
string
, ignorePaths
:
string
[]
)
:
boolean
Parameters
path:
string
ignorePaths:
string
[]
Returns
boolean
Generated using
TypeDoc